-;;; info.el --- info package for Emacs.
+;;; info.el --- info package for Emacs
-;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 97, 98, 99, 2000 Free Software
-;; Foundation, Inc.
+;; Copyright (C) 1985, 86, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001
+;; Free Software Foundation, Inc.
;; Maintainer: FSF
;; Keywords: help
(defface info-menu-5
'((((class color)) (:foreground "red1"))
(t (:underline t)))
- "Face for the fifth and tenth `*' in an Info menu."
+ "Face for the fifth and nineth `*' in an Info menu."
:group 'info)
(defface info-xref
if there is no INFOPATH variable in the environment.
When `Info-directory-list' is initialized from the value of
-`Info-default-directory-list', the first element of the resulting
+`Info-default-directory-list', and Emacs is installed in one of the
+standard directories, the directory of Info files that come with Emacs
+is put last (so that local Info files override standard ones).
+
+When `Info-directory-list' is initialized from the value of
+`Info-default-directory-list', and Emacs is not installed in one
+of the standard directories, the first element of the resulting
list is the directory where Emacs installs the Info files that
come with it. This is so that Emacs's own manual, which suits the
-version of Emacs you are using, will always be found first. (If
-you want to override that, set INFOPATH in the environment.)
+version of Emacs you are using, will always be found first. This
+is useful when you install an experimental version of Emacs without
+removing the standard installation.
+
+If you want to override the order of directories in
+`Info-default-directory-list', set INFOPATH in the environment.
If you run the Emacs executable from the `src' directory in the Emacs
source tree, and INFOPATH is not defined, the `info' directory in the
(defcustom Info-additional-directory-list nil
"List of additional directories to search for Info documentation files.
-These directories are not searched for merging the `dir' file."
+These directories are searched after those in `Info-directory-list', and
+they are not searched for merging the `dir' file."
:type '(repeat directory)
:group 'info)
+(defcustom Info-scroll-prefer-subnodes t
+ "*If non-nil, \\<Info-mode-map>\\[Info-scroll-up] in a menu visits subnodes.
+If this is non-nil, and you scroll far enough in a node that its menu
+appears on the screen, the next \\<Info-mode-map>\\[Info-scroll-up]
+moves to a subnode indicated by the following menu item. This means
+that you visit a subnode before getting to the end of the menu.
+
+Setting this option to nil results in behavior similar to the stand-alone
+Info reader program, which visits the first subnode from the menu only
+when you hit the end of the current node."
+ :type 'boolean
+ :group 'info)
+
(defvar Info-current-file nil
"Info file that Info is now looking at, or nil.
This is the name that was specified in Info, not the actual file name.
(if (eq system-type 'ms-dos)
'( (".gz" . "gunzip")
(".z" . "gunzip")
- (".bz2" . "bzip2 -dc")
+ (".bz2" . ("bzip2" "-dc"))
(".inz" . "gunzip")
(".igz" . "gunzip")
(".info.Z" . "gunzip")
(".info.Y". "unyabba")
(".info.gz". "gunzip")
(".info.z". "gunzip")
- (".info.bz2" . "bzip2 -dc")
+ (".info.bz2" . ("bzip2" "-dc"))
(".info". nil)
("-info.Z". "uncompress")
("-info.Y". "unyabba")
("-info.gz". "gunzip")
- ("-info.bz2" . "bzip2 -dc")
+ ("-info.bz2" . ("bzip2" "-dc"))
("-info.z". "gunzip")
("-info". nil)
("/index.Z". "uncompress")
("/index.Y". "unyabba")
("/index.gz". "gunzip")
("/index.z". "gunzip")
- ("/index.bz2". "bzip2 -dc")
+ ("/index.bz2". ("bzip2" "-dc"))
("/index". nil)
(".Z". "uncompress")
(".Y". "unyabba")
(".gz". "gunzip")
(".z". "gunzip")
- (".bz2" . "bzip2 -dc")
+ (".bz2" . ("bzip2" "-dc"))
("". nil)))
"List of file name suffixes and associated decoding commands.
Each entry should be (SUFFIX . STRING); the file is given to
-the command as standard input. If STRING is nil, no decoding is done.
+the command as standard input.
+
+STRING may be a list of strings. In that case, the first element is
+the command name, and the rest are arguments to that command.
+
+If STRING is nil, no decoding is done.
Because the SUFFIXes are tried in order, the empty string should
be last in the list.")
;; Concatenate SUFFIX onto FILENAME. SUFFIX should start with a dot.
-;; First, on ms-dos, delete some of the extension in FILENAME
-;; to make room.
-(defun info-insert-file-contents-1 (filename suffix)
- (if (not (eq system-type 'ms-dos))
+;; First, on MS-DOS with no long file names support, delete some of
+;; the extension in FILENAME to make room.
+(defun info-insert-file-contents-1 (filename suffix lfn)
+ (if lfn ; long file names are supported
(concat filename suffix)
(let* ((sans-exts (file-name-sans-extension filename))
;; How long is the extension in FILENAME (not counting the dot).
(defun info-insert-file-contents (filename &optional visit)
"Insert the contents of an info file in the current buffer.
Do the right thing if the file has been compressed or zipped."
- (let ((tail Info-suffix-list)
- fullname decoder)
- (if (file-exists-p filename)
+ (let* ((tail Info-suffix-list)
+ (lfn (or (not (fboundp 'msdos-long-file-names))
+ (msdos-long-file-names)))
+ (check-short (and (fboundp 'msdos-long-file-names)
+ lfn))
+ fullname decoder done)
+ (if (info-file-exists-p filename)
;; FILENAME exists--see if that name contains a suffix.
;; If so, set DECODE accordingly.
(progn
(setq fullname filename
decoder (cdr (car tail))))
;; Try adding suffixes to FILENAME and see if we can find something.
- (while (and tail
- (not (info-file-exists-p (info-insert-file-contents-1
- filename (car (car tail))))))
+ (while (and tail (not done))
+ (setq fullname (info-insert-file-contents-1 filename
+ (car (car tail)) lfn))
+ (if (info-file-exists-p fullname)
+ (setq done t
+ ;; If we found a file with a suffix, set DECODER
+ ;; according to the suffix.
+ decoder (cdr (car tail)))
+ ;; When the MS-DOS port runs on Windows, we need to check
+ ;; the short variant of a long file name as well.
+ (when check-short
+ (setq fullname (info-insert-file-contents-1 filename
+ (car (car tail)) nil))
+ (if (info-file-exists-p fullname)
+ (setq done t
+ decoder (cdr (car tail))))))
(setq tail (cdr tail)))
- ;; If we found a file with a suffix, set DECODER according to the suffix
- ;; and set FULLNAME to the file's actual name.
- (setq fullname (info-insert-file-contents-1 filename (car (car tail)))
- decoder (cdr (car tail)))
(or tail
(error "Can't find %s or any compressed version of it" filename)))
;; check for conflict with jka-compr
(coding-system-for-write 'no-conversion)
(default-directory (or (file-name-directory fullname)
default-directory)))
- (call-process-region (point-min) (point-max) decoder t t)))
+ (or (consp decoder)
+ (setq decoder (list decoder)))
+ (apply 'call-process-region (point-min) (point-max)
+ (car decoder) t t nil (cdr decoder))))
(insert-file-contents fullname visit))))
\f
(defun info-initialize ()
(let ((path (getenv "INFOPATH"))
(source (expand-file-name "info/" source-directory))
(sibling (if installation-directory
- (expand-file-name "info/" installation-directory)))
+ (expand-file-name "info/" installation-directory)
+ (if invocation-directory
+ (let ((infodir (expand-file-name
+ "../info/"
+ invocation-directory)))
+ (if (file-exists-p infodir)
+ infodir
+ (setq infodir (expand-file-name
+ "../../../info/"
+ invocation-directory))
+ (and (file-exists-p infodir)
+ infodir))))))
alternative)
(setq Info-directory-list
(prune-directory-list
(setq temp-downcase
(expand-file-name (downcase filename) (car dirs)))
;; Try several variants of specified name.
- (let ((suffix-list Info-suffix-list))
+ (let ((suffix-list Info-suffix-list)
+ (lfn (or (not (fboundp 'msdos-long-file-names))
+ (msdos-long-file-names))))
(while (and suffix-list (not found))
(cond ((info-file-exists-p
(info-insert-file-contents-1
- temp (car (car suffix-list))))
+ temp (car (car suffix-list)) lfn))
(setq found temp))
((info-file-exists-p
(info-insert-file-contents-1
- temp-downcase (car (car suffix-list))))
- (setq found temp-downcase)))
+ temp-downcase (car (car suffix-list)) lfn))
+ (setq found temp-downcase))
+ ((and (fboundp 'msdos-long-file-names)
+ lfn
+ (info-file-exists-p
+ (info-insert-file-contents-1
+ temp (car (car suffix-list)) nil)))
+ (setq found temp)))
(setq suffix-list (cdr suffix-list))))
(setq dirs (cdr dirs)))))
(if found
;; Search file for a suitable node.
(let ((guesspos (point-min))
(regexp (concat "\\(Node:\\|Ref:\\) *\\("
- (if (stringp nodename)
+ (if (stringp nodename)
(regexp-quote nodename)
"")
"\\) *[,\t\n\177]"))
(while buffers
(kill-buffer (car buffers))
(setq buffers (cdr buffers)))
+ (if Info-fontify (Info-fontify-menu-headers))
(goto-char (point-min))
(if problems
(message "Composing main Info directory...problems encountered, see `*Messages*'")
(info-insert-file-contents lastfilename)
(set-buffer-modified-p nil)
(setq Info-current-subfile lastfilename)))
+ ;; Widen in case we are in the same subfile as before.
+ (widen)
(goto-char (point-min))
(if (looking-at "\^_")
(forward-char 1)
;; should be called when the node is already narrowed.
(defun Info-setup-header-line ()
(goto-char (point-min))
- (forward-line 1)
- (set (make-local-variable 'Info-header-line)
- (buffer-substring (point-min) (1- (point))))
- (setq header-line-format 'Info-header-line)
- (narrow-to-region (point) (point-max)))
+ (let* ((case-fold-search t)
+ (header-end (save-excursion (forward-line 1) (1- (point))))
+ ;; If we find neither Next: nor Prev: link, show the entire
+ ;; node header. Otherwise, don't show the File: and Node:
+ ;; parts, to avoid wasting precious space on information that
+ ;; is available in the mode line.
+ (header-beg (if (re-search-forward
+ "\\(next\\|prev[ious]*\\): "
+ header-end t)
+ (match-beginning 1)
+ (point))))
+ (set (make-local-variable 'Info-header-line)
+ (buffer-substring header-beg header-end))
+ (setq header-line-format 'Info-header-line)
+ (narrow-to-region (1+ header-end) (point-max))))
\f
;; Go to an info node specified with a filename-and-nodename string
;; of the sort that is found in pointers in nodes.
(defun Info-goto-node (nodename &optional fork)
- "Go to info node named NAME. Give just NODENAME or (FILENAME)NODENAME.
+ "Go to info node named NODENAME. Give just NODENAME or (FILENAME)NODENAME.
If FORK is non-nil (interactively with a prefix arg), show the node in
a new info buffer.
If FORK is a string, it is the name to use for the new buffer."
(cons (list (match-string-no-properties 1))
compl))))))))
(setq compl (cons '("*") compl))
- (setq Info-current-file-completions compl))))
+ (set (make-local-variable 'Info-current-file-completions) compl))))
\f
(defun Info-restore-point (hl)
"If this node has been visited, restore the point value when we left."
(defun Info-search (regexp)
"Search for REGEXP, starting from point, and select node it's found in."
- (interactive (list (read-string "Regexp search: "
- nil 'Info-search-history)))
+ (interactive (list (read-string
+ (if Info-search-history
+ (format "Regexp search (default `%s'): "
+ (car Info-search-history))
+ "Regexp search: ")
+ nil 'Info-search-history)))
(when transient-mark-mode
(deactivate-mark))
(when (equal regexp "")
(message "Searching subfile %s..." (cdr (car list)))
(Info-read-subfile (car (car list)))
(setq list (cdr list))
-;;; (goto-char (point-min))
(if (re-search-forward regexp nil t)
(setq found (point) list ())))
(if found
(not (string-match "\\<index\\>" Info-current-node)))
(Info-goto-node (Info-extract-menu-counting 1))
t)
- ((save-excursion (search-backward "next:" nil t))
+ ((save-excursion
+ (save-restriction
+ (let (limit)
+ (when Info-header-line
+ (goto-char (point-min))
+ (widen)
+ (forward-line -1)
+ (setq limit (point))
+ (forward-line 1))
+ (search-backward "next:" limit t))))
(Info-next)
t)
- ((and (save-excursion (search-backward "up:" nil t))
+ ((and (save-excursion
+ (save-restriction
+ (let (limit)
+ (when Info-header-line
+ (goto-char (point-min))
+ (widen)
+ (forward-line -1)
+ (setq limit (point))
+ (forward-line 1))
+ (search-backward "up:" limit t))))
;; Use string-equal, not equal, to ignore text props.
(not (string-equal (downcase (Info-extract-pointer "up"))
"top")))
;; so we can scroll back through it.
(goto-char (point-max))))
(recenter -1))
- ((and (not (equal (Info-extract-pointer "up")
+ ((and (Info-no-error (Info-extract-pointer "prev"))
+ (not (equal (Info-extract-pointer "up")
(Info-extract-pointer "prev"))))
(Info-no-error (Info-prev))
(goto-char (point-max))
(defun Info-scroll-up ()
"Scroll one screenful forward in Info, considering all nodes as one sequence.
Once you scroll far enough in a node that its menu appears on the screen
-but after point, the next scroll moves into its first subnode.
+but after point, the next scroll moves into its first subnode, unless
+`Info-scroll-prefer-subnodes' is nil.
-When you scroll past the end of a node, that goes to the next node; if
-this node has no successor, it moves to the parent node's successor,
-and so on. If point is inside the menu of a node, it moves to
-subnode indicated by the following menu item. (That case won't
-normally result from this command, but can happen in other ways.)"
+When you scroll past the end of a node, that goes to the next node if
+`Info-scroll-prefer-subnodes' is non-nil and to the first subnode otherwise;
+if this node has no successor, it moves to the parent node's successor,
+and so on. If `Info-scroll-prefer-subnodes' is non-nil and point is inside
+the menu of a node, it moves to subnode indicated by the following menu
+item. (That case won't normally result from this command, but can happen
+in other ways.)"
(interactive)
(if (or (< (window-start) (point-min))
(let* ((case-fold-search t)
(virtual-end (save-excursion
(goto-char (point-min))
- (if (search-forward "\n* Menu:" nil t)
+ (if (and Info-scroll-prefer-subnodes
+ (search-forward "\n* Menu:" nil t))
(point)
(point-max)))))
(if (or (< virtual-end (window-start))
(pos-visible-in-window-p virtual-end))
- (Info-next-preorder)
+ (cond
+ (Info-scroll-prefer-subnodes (Info-next-preorder))
+ ((Info-no-error (Info-goto-node (Info-extract-menu-counting 1))))
+ (t (Info-next-preorder)))
(scroll-up))))
(defun Info-scroll-down ()
"Scroll one screenful back in Info, considering all nodes as one sequence.
-Within the menu of a node, this goes to its last subnode.
-When you scroll past the beginning of a node, that goes to the
-previous node or back up to the parent node."
+If point is within the menu of a node, and `Info-scroll-prefer-subnodes'
+is non-nil, this goes to its last subnode. When you scroll past the
+beginning of a node, that goes to the previous node or back up to the
+parent node."
(interactive)
(if (or (< (window-start) (point-min))
(> (window-start) (point-max)))
(set-window-start (selected-window) (point)))
(let* ((case-fold-search t)
(current-point (point))
- (virtual-end (save-excursion
- (beginning-of-line)
- (setq current-point (point))
- (goto-char (point-min))
- (search-forward "\n* Menu:"
- current-point
- t))))
- (if (or virtual-end (pos-visible-in-window-p (point-min)))
+ (virtual-end
+ (and Info-scroll-prefer-subnodes
+ (save-excursion
+ (beginning-of-line)
+ (setq current-point (point))
+ (goto-char (point-min))
+ (search-forward "\n* Menu:"
+ current-point
+ t)))))
+ (if (or virtual-end
+ (pos-visible-in-window-p (point-min) nil t))
(Info-last-preorder)
(scroll-down))))
:help "Look for another occurrence of previous item"])
["Edit" Info-edit :help "Edit contents of this node"
:active Info-enable-edit]
+ ["Copy Node Name" Info-copy-current-node-name
+ :help "Copy the name of the current node into the kill ring"]
["Exit" Info-exit :help "Stop reading Info"]))
(if items
(setq entries (cons ["Other..." Info-menu t] entries)))
(or entries
- (setq entries (list ["No menu" nil nil])))
+ (setq entries (list ["No menu" nil nil] nil :active)))
(easy-menu-change '("Info") "Menu Item" (nreverse entries)))
;; Update reference menu. Code stolen from `Info-follow-reference'.
(let ((items nil)
(setq entries (cons ["Other..." Info-follow-reference t]
entries)))
(or entries
- (setq entries (list ["No references" nil nil])))
+ (setq entries (list ["No references" nil nil] nil :active)))
(easy-menu-change '("Info") "Reference" (nreverse entries)))
;; Update last seen node.
(setq Info-menu-last-node (list Info-current-file Info-current-node)))
;; Try to avoid entering infinite beep mode in case of errors.
(error (ding))))
+\f
+(defun Info-copy-current-node-name ()
+ "Put the name of the current info node into the kill ring.
+The name of the info file is prepended to the node name in parentheses."
+ (interactive)
+ (unless Info-current-node
+ (error "No current info node"))
+ (kill-new
+ (concat "("
+ (file-name-nondirectory
+ (if (stringp Info-current-file)
+ Info-current-file
+ (or buffer-file-name "")))
+ ")"
+ Info-current-node)))
+
\f
;; Info mode is suitable only for specially formatted data.
(put 'Info-mode 'mode-class 'special)
(setq mode-name "Info")
(setq tab-width 8)
(use-local-map Info-mode-map)
- (make-local-hook 'activate-menubar-hook)
(add-hook 'activate-menubar-hook 'Info-menu-update nil t)
(set-syntax-table text-mode-syntax-table)
(setq local-abbrev-table text-mode-abbrev-table)
;; This is for the sake of the invisible text we use handling titles.
(make-local-variable 'line-move-ignore-invisible)
(setq line-move-ignore-invisible t)
- (add-hook (make-local-hook 'clone-buffer-hook) 'Info-clone-buffer-hook nil t)
+ (add-hook 'clone-buffer-hook 'Info-clone-buffer-hook nil t)
(Info-set-mode-line)
(run-hooks 'Info-mode-hook))
(defun Info-clone-buffer-hook ()
(when (bufferp Info-tag-table-buffer)
(setq Info-tag-table-buffer
- (with-current-buffer Info-tag-table-buffer (clone-buffer)))
- (let ((m Info-tag-table-marker))
- (when (and (markerp m) (marker-position m))
- (setq Info-tag-table-marker
- (with-current-buffer Info-tag-table-buffer
- (copy-marker (marker-position m))))))))
+ (with-current-buffer Info-tag-table-buffer (clone-buffer))))
+ (let ((m Info-tag-table-marker))
+ (when (markerp m)
+ (setq Info-tag-table-marker
+ (if (and (marker-position m) (bufferp Info-tag-table-buffer))
+ (with-current-buffer Info-tag-table-buffer
+ (copy-marker (marker-position m)))
+ (make-marker))))))
(defvar Info-edit-map (let ((map (make-sparse-keymap)))
(set-keymap-parent map text-mode-map)
(message "Tags may have changed. Use Info-tagify if necessary")))
\f
(defvar Info-file-list-for-emacs
- '("ediff" "forms" "gnus" ("mh" . "mh-e") "sc" "message"
+ '("ediff" "forms" "gnus" "info" ("mh" . "mh-e") "sc" "message"
("dired" . "dired-x") ("c" . "ccmode") "viper" "vip"
("skeleton" . "autotype") ("auto-insert" . "autotype")
("copyright" . "autotype") ("executable" . "autotype")
;;;###autoload
(defun Info-goto-emacs-command-node (command)
"Go to the Info node in the Emacs manual for command COMMAND.
-The command is found by looking up in Emacs manual's Command Index
+The command is found by looking up in Emacs manual's indices
or in another manual found via COMMAND's `info-file' property or
the variable `Info-file-list-for-emacs'."
(interactive "CFind documentation for command: ")
;;;###autoload
(defun Info-goto-emacs-key-command-node (key)
- "Go to the Info node in the Emacs manual the command bound to KEY, a string.
+ "Go to the node in the Emacs manual which describes the command bound to KEY.
+KEY is a string.
Interactively, if the binding is `execute-extended-command', a command is read.
-The command is found by looking up in Emacs manual's Command Index
+The command is found by looking up in Emacs manual's indices
or in another manual found via COMMAND's `info-file' property or
the variable `Info-file-list-for-emacs'."
(interactive "kFind documentation for key: ")
"Face for Info titles at level 4."
:group 'info)
+(defface info-menu-header
+ '((((type tty pc))
+ :underline t
+ :weight bold)
+ (t
+ :inherit variable-pitch
+ :weight bold))
+ "Face for headers in Info menus."
+ :group 'info)
+
+(defun Info-fontify-menu-headers ()
+ "Add the face `info-menu-header' to any header before a menu entry."
+ (save-excursion
+ (goto-char (point-min))
+ (when (re-search-forward "\\* Menu:" nil t)
+ (put-text-property (match-beginning 0) (match-end 0)
+ 'face 'info-menu-header)
+ (while (re-search-forward "\n\n\\([^*\n ].*\\)\n\n?[*]" nil t)
+ (put-text-property (match-beginning 1) (match-end 1)
+ 'face 'info-menu-header)))))
+
(defun Info-fontify-node ()
(save-excursion
(let ((buffer-read-only nil)
;; This is a serious problem for trying to handle multiple
;; frame types at once. We want this text to be invisible
;; on frames that can display the font above.
- (if (memq (framep (selected-frame)) '(x pc w32 mac))
- (add-text-properties (match-end 1) (match-end 2)
- '(invisible t intangible t))))
+ (when (memq (framep (selected-frame)) '(x pc w32 mac))
+ (add-text-properties (match-end 1) (match-end 2)
+ '(invisible t intangible t))
+ (add-text-properties (1- (match-end 1)) (match-end 2)
+ '(intangible t))))
(goto-char (point-min))
(while (re-search-forward "\\*Note[ \n\t]+\\([^:]*\\):" nil t)
(if (= (char-after (1- (match-beginning 0))) ?\") ; hack
'(face info-xref
mouse-face highlight
help-echo "mouse-2: go to this node")))))
+ (Info-fontify-menu-headers)
(set-buffer-modified-p nil))))
\f