xemacs-beta: lisp/info.el comparison

comparison lisp/info.el @ 412:697ef44129c6 r21-2-14

Import from CVS: tag r21-2-14

author	cvs
date	Mon, 13 Aug 2007 11:20:41 +0200
parents	de805c49cfc1
children	da8ed4261e83

comparison

equal deleted inserted replaced

-:12e008d41344
+:697ef44129c6
 ;; 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 <didier@xemacs.org>
+;; Modified 1998-09-23 by Didier Verna <verna@inf.enst.fr>
 ;;
 ;; 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
+(defcustom Info-save-auto-generated-dir nil
 "*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)
 ;;;###autoload
 (defvar Info-directory-list nil
 "List of directories to search for Info documentation files.
 The first directory in this list, the \"dir\" file there will become
-the (dir)Top node of the Info documentation tree.
+the (dir)Top node of the Info documentation tree.  If you wish to
+modify the info search path, use `M-x customize-variable,
-Note: DO NOT use the `customize' interface to change the value of this
+Info-directory-list' to do so.")
-variable.  Its value is created dynamically on each startup, depending
-on XEmacs packages installed on the system.  If you want to change the
-search path, make the needed modifications on the variable's value
-from .emacs.  For instance:
-(setq Info-directory-list (cons \"~/info\" Info-directory-list))")
 (defcustom Info-localdir-heading-regexp
 "^Locally installed XEmacs Packages:?"
 "The menu part of localdir files will be inserted below this topic
 heading."
 (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")
 			    (".bz2" . "bzip2 -dc %s")
 			    (".gz" . "gzip -dc %s")
 (defvar Info-index-alternatives nil
 "List of possible matches for last Info-index command.")
 (defvar Info-index-first-alternative nil)
-(defcustom Info-annotations-path
+(defcustom Info-annotations-path '("~/.xemacs/info.notes"
-(list
+"~/.infonotes"
-(paths-construct-path (list user-init-directory "info.notes"))
+				   "/usr/lib/info.notes")
-(paths-construct-path '("~" ".infonotes"))
-(paths-construct-path '("usr" "lib" "info.notes")
-			 (char-to-string directory-sep-char)))
 "*Names of files that contain annotations for different Info nodes.
 By convention, the first one should reside in your personal directory.
 The last should be a world-writable \"public\" annotations file."
 :type '(repeat file)
 :group 'info)
 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.
 ")
 (while f
 (if (and (file-exists-p (car f)) (not (get-file-buffer (car f))))
 	  (bury-buffer (find-file-noselect (car f))))
 (setq f (cdr f)))))
-;;;###autoload
 (defun Info-find-node (filename &optional nodename no-going-back tryfile line)
 "Go to an info node specified as separate FILENAME and NODENAME.
 Look for a plausible filename, or if not found then look for URL's and
 dispatch to the appropriate fn.  NO-GOING-BACK is non-nil if
 recovering from an error in this function; it says do not attempt
 ;; 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
 			      nil t nil
 			      'Info-minibuffer-history)))
 (or (equal tag "") (Info-find-node nil (format "<<%s>>" tag)))))
 ;;;###autoload
-(defun Info-visit-file (file)
+(defun Info-visit-file ()
 "Directly visit an info file."
-(interactive "fVisit Info file: ")
+(interactive)
-(Info-find-node (expand-file-name file) "Top"))
+(let* ((insert-default-directory nil)
+	 (file (read-file-name "Goto Info file: " "" "")))
+(or (equal file "") (Info-find-node (expand-file-name file) "Top"))))
 (defun Info-restore-point (&optional always)
 "Restore point to same location it had last time we were in this node."
 (interactive "p")
 (if (or Info-restoring-point always)
 (and (nth 2 entry)
 (get-buffer-window (current-buffer))
 (set-window-start (get-buffer-window (current-buffer))
 			 (+ (nth 2 entry) (point-min)))))
-(defvar Info-read-node-completion-table)
-;; This function is used as the "completion table" while reading a node name.
-;; It does completion using the alist in Info-read-node-completion-table
-;; unless STRING starts with an open-paren.
-(defun Info-read-node-name-1 (string predicate code)
-(let ((no-completion (and (> (length string) 0) (eq (aref string 0) ?\())))
-(cond ((eq code nil)
-	   (if no-completion
-	       string
-	     (try-completion string Info-read-node-completion-table predicate)))
-	  ((eq code t)
-	   (if no-completion
-	       nil
-	     (all-completions string Info-read-node-completion-table predicate)))
-	  ((eq code 'lambda)
-	   (if no-completion
-	       t
-	     (assoc string Info-read-node-completion-table))))))
 (defun Info-read-node-name (prompt &optional default)
 (Info-setup-initial)
 (let* ((completion-ignore-case t)
-	 (Info-read-node-completion-table (Info-build-node-completions))
+	 (nodename (completing-read prompt
-	 (nodename (completing-read prompt 'Info-read-node-name-1
+				    (Info-build-node-completions)
-				    nil t nil 'Info-minibuffer-history
+				    nil nil nil
-				    default)))
+				    'Info-minibuffer-history)))
 (if (equal nodename "")
 	(or default
 	    (Info-read-node-name prompt))
 nodename)))
 		(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))))
 ;;;###autoload
 (defun Info-search (regexp)
 "Search for REGEXP, starting from point, and select node it's found in."
-(interactive (list
+(interactive "sSearch (regexp): ")
-		(read-from-minibuffer
+(if (equal regexp "")
-		 (if Info-last-search
+(setq regexp Info-last-search)
-		     (format "Search (regexp, default %s): "
+(setq Info-last-search regexp))
-			     Info-last-search)
-		   "Search (regexp): ")
-		 nil nil nil nil nil Info-last-search)))
-(setq Info-last-search regexp)
 (with-search-caps-disable-folding regexp t
 (let ((found ())
 (onode Info-current-node)
 (ofile Info-current-file)
 (opoint (point))
 (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)
 	   nil
 	 (error (concat "Node has no " (capitalize (or errorname name)))))))))
 ;; Return the node name in the buffer following point.
 ;; ALLOWEDCHARS, if non-nil, goes within [...] to make a regexp
-;; saying which chars may appear in the node name.
+;; saying which chas may appear in the node name.
 (defun Info-following-node-name (&optional allowedchars)
 (skip-chars-forward " \t")
 (buffer-substring
 (point)
 (progn
 (while (looking-at (concat "[" (or allowedchars "^,\t\n") "]"))
 (skip-chars-forward (concat (or allowedchars "^,\t\n") "("))
 (if (looking-at "(")
 	   (skip-chars-forward "^)")))
-(skip-chars-backward " .")
+(skip-chars-backward " ")
 (point))))
 (defun Info-next (&optional n)
 "Go to the next node of this node.
 A positive or negative prefix argument moves by multiple nodes."
 	 (let ((item (completing-read (if default
 					  (concat "Follow reference named: ("
 						  default ") ")
 					"Follow reference named: ")
 				      completions nil t nil
-				      'Info-minibuffer-history
+				      'Info-minibuffer-history)))
-				      default)))
 	   (if (and (string= item "") default)
 	       (list default)
 	     (list item)))
 (error "No cross-references in this node"))))
 (let (target i (str (concat "\\*" Info-footnote-tag " "
 (forward-char 1)
 (setq str
 	  (if (looking-at ":")
 	      (buffer-substring beg (1- (point)))
 	    (skip-chars-forward " \t\n")
-	    ;; Kludge.
+	    (Info-following-node-name (if multi-line "^.,\t" "^.,\t\n"))))
-	    ;; Allow dots in node name not followed by whitespace.
-	    (re-search-forward
-	     (concat "\\(([^)]+)[^."
-		     (if multi-line "" "\n")
-		     "]*\\|\\([^.,\t"
-		     (if multi-line "" "\n")
-		     ;; We consider dots followed by newline as
-		     ;; end of nodename even if multil-line.
-		     ;; Also stops at .).  It is generated by @pxref.
-		     ;; Skips sequential dots.
-		     "]\\|\\.+[^ \t\n)]\\)+\\)"))
-	    (match-string 1)))
 (while (setq i (string-match "\n" str i))
 (aset str i ?\ ))
 str))
 (defun Info-menu (menu-item)
 		      (completing-read (if default
 					   (format "Menu item (default %s): "
 						   default)
 					   "Menu item: ")
 				       completions nil t nil
-				       'Info-minibuffer-history
+				       'Info-minibuffer-history)))
-				       default)))
 	 ;; we rely on the fact that completing-read accepts an input
 	 ;; of "" even when the require-match argument is true and ""
 	 ;; is not a valid possibility
 	 (if (string= item "")
 	     (if default
 	         (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))
 (while (>= (setq n (1- n)) 0)
 (if (pos-visible-in-window-p (point-min))
 	  (progn
 	    (Info-global-prev)
 	    (message "Node: %s" Info-current-node)
-	    (goto-char (point-max))
+	    (sit-for 0)
-	    (recenter -1)
+	    ;;(scroll-up 1)   ; work around bug in pos-visible-in-window-p
-	    (move-to-window-line 0))
+	    ;;(scroll-down 1)
+	    (while (not (pos-visible-in-window-p (point-max)))
+	      (scroll-up)))
 	(scroll-down)))))
 (defun Info-scroll-prev (arg)
 (interactive "P")
 (if Info-auto-advance
 (if (and (pos-visible-in-window-p (point-min))
 	       (not (eq Info-auto-advance t))
 	       (not (eq last-command this-command)))
 	  (message "Hit %s again to go to previous node"
-		   (if (mouse-event-p last-command-event)
+		   (if (= last-command-char 0)
 		       "mouse button"
-		     (key-description (event-key last-command-event))))
+		     (key-description (char-to-string last-command-char))))
 	(Info-page-prev)
 	(setq this-command 'Info))
 (scroll-down arg)))
 (defun Info-index (topic)
 Use the `,' command to see the other matches.
 Give a blank topic name to go to the Index node itself."
 (interactive "sIndex topic: ")
 (let ((pattern (format "\n\\* \\([^\n:]*%s[^\n:]*\\):[ \t]*%s"
 			 (regexp-quote topic)
-			 "\\(.*\\)\\.[ t]*\\([0-9]*\\)$"))
+			 "\\([^.\n]*\\)\\.[ t]*\\([0-9]*\\)"))
 	node)
 (message "Searching index for `%s'..." topic)
 (Info-goto-node "Top")
 (let ((case-fold-search t))
 (or (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 @ 412:697ef44129c6 r21-2-14