emacs: lisp/help-fns.el comparison

comparison lisp/help-fns.el @ 90261:7beb78bc1f8e

Revision: miles@gnu.org--gnu-2005/emacs--unicode--0--patch-97 Merge from emacs--cvs-trunk--0 Patches applied: * emacs--cvs-trunk--0 (patch 616-696) - Add lisp/mh-e/.arch-inventory - Update from CVS - Merge from gnus--rel--5.10 - Update from CVS: lisp/smerge-mode.el: Add 'tools' to file keywords. - lisp/gnus/ChangeLog: Remove duplicate entry * gnus--rel--5.10 (patch 147-181) - Update from CVS - Merge from emacs--cvs-trunk--0 - Update from CVS: lisp/mml.el (mml-preview): Doc fix. - Update from CVS: texi/message.texi: Fix default values. - Update from CVS: texi/gnus.texi (RSS): Addition.

author	Miles Bader <miles@gnu.org>
date	Mon, 16 Jan 2006 08:37:27 +0000
parents	fa0da9b57058 3cc8c13facd3
children	7432ca837c8d

comparison

equal deleted inserted replaced

-:0ca0d9181b5e
+:7beb78bc1f8e
 ;;; help-fns.el --- Complex help functions
 ;; Copyright (C) 1985, 1986, 1993, 1994, 1998, 1999, 2000, 2001,
-;;   2002, 2003, 2004, 2005 Free Software Foundation, Inc.
+;;   2002, 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
 ;; Maintainer: FSF
 ;; Keywords: help, internal
 ;; This file is part of GNU Emacs.
 	  (newline (- n (/ n 2)))))
 (goto-char (point-min))
 (setq buffer-undo-list nil)
 (set-buffer-modified-p nil))))
-;;;###autoload
-(defun locate-library (library &optional nosuffix path interactive-call)
-"Show the precise file name of Emacs library LIBRARY.
-This command searches the directories in `load-path' like `\\[load-library]'
-to find the file that `\\[load-library] RET LIBRARY RET' would load.
-Optional second arg NOSUFFIX non-nil means don't add suffixes `load-suffixes'
-to the specified name LIBRARY.
-If the optional third arg PATH is specified, that list of directories
-is used instead of `load-path'.
-When called from a program, the file name is normaly returned as a
-string.  When run interactively, the argument INTERACTIVE-CALL is t,
-and the file name is displayed in the echo area."
-(interactive (list (completing-read "Locate library: "
-				      'locate-file-completion
-				      (cons load-path load-suffixes))
-		     nil nil
-		     t))
-(let ((file (locate-file library
-			   (or path load-path)
-			   (append (unless nosuffix load-suffixes) '("")))))
-(if interactive-call
-	(if file
-	    (message "Library is file %s" (abbreviate-file-name file))
-	  (message "No library %s in search path" library)))
-file))
 ;; Functions
 ;;;###autoload
 (defun describe-function (function)
 	    (setq file (replace-match ".c" t t file)))
 	(if (string-match "\\.c\\'" file)
 	    (concat "src/" file)
 	  file)))))
-;;;###autoload
 (defface help-argument-name '((((supports :slant italic)) :inherit italic))
 "Face to highlight argument names in *Help* buffers."
 :group 'help)
 (defun help-default-arg-highlight (arg)
 (setq usage (help-do-arg-highlight (buffer-string) args))
 ;; Highlight arguments in the DOC string
 (setq doc (and doc (help-do-arg-highlight doc args))))))
 ;; Return value is like the one from help-split-fundoc, but highlighted
 (cons usage doc))
+;;;###autoload
+(defun describe-simplify-lib-file-name (file)
+"Simplify a library name FILE to a relative name, and make it a source file."
+(if file
+;; Try converting the absolute file name to a library name.
+(let ((libname (file-name-nondirectory file)))
+	;; Now convert that back to a file name and see if we get
+	;; the original one.  If so, they are equivalent.
+	(if (equal file (locate-file libname load-path '("")))
+	    (if (string-match "[.]elc\\'" libname)
+		(substring libname 0 -1)
+	      libname)
+	  file))))
 ;;;###autoload
 (defun describe-function-1 (function)
 (let* ((def (if (symbolp function)
 		  (symbol-function function)
 	(save-match-data
 	  (if (re-search-backward "alias for `\\([^`']+\\)'" nil t)
 	      (help-xref-button 1 'help-function def)))))
 (or file-name
 	(setq file-name (symbol-file function 'defun)))
+(setq file-name (describe-simplify-lib-file-name file-name))
 (when (equal file-name "loaddefs.el")
 ;; Find the real def site of the preloaded function.
 ;; This is necessary only for defaliases.
 (let ((location
 	     (condition-case nil
 ((or (stringp def)
 (vectorp def))
 (format "\nMacro: %s" (format-kbd-macro def)))
 (t "[Missing arglist.  Please make a bug report.]")))
 (high (help-highlight-arguments use doc)))
-(insert (car high) "\n")
+(let ((fill-begin (point)))
+	      (insert (car high) "\n")
+	      (fill-region fill-begin (point)))
 (setq doc (cdr high))))
 (let ((obsolete (and
 ;; function might be a lambda construct.
 (symbolp function)
 (get function 'byte-obsolete-info))))
 	 val)
 (setq val (completing-read (if (symbolp v)
 				    (format
 				     "Describe variable (default %s): " v)
 				  "Describe variable: ")
-				obarray 'boundp t nil nil
+				obarray
+				'(lambda (vv)
+				   (or (boundp vv)
+				       (get vv 'variable-documentation)))
+				t nil nil
 				(if (symbolp v) (symbol-name v))))
 (list (if (equal val "")
 	       v (intern val)))))
 (unless (buffer-live-p buffer) (setq buffer (current-buffer)))
 (if (not (symbolp variable))
 	    (prin1 variable)
 	    ;; Make a hyperlink to the library if appropriate.  (Don't
 	    ;; change the format of the buffer's initial line in case
 	    ;; anything expects the current format.)
 	    (let ((file-name (symbol-file variable 'defvar)))
+	      (setq file-name (describe-simplify-lib-file-name file-name))
 	      (when (equal file-name "loaddefs.el")
 		;; Find the real def site of the preloaded variable.
 		(let ((location
 		       (condition-case nil
 			   (find-variable-noselect variable file-name)
 		      (save-excursion
 			(re-search-backward "`\\([^`']+\\)'" nil t)
 			(help-xref-button 1 'help-variable-def
 					  variable file-name)))
 		    (if valvoid
-			(princ "It is void as a variable.\n")
+			(princ "It is void as a variable.")
 		      (princ "Its ")))
 		(if valvoid
-		    (princ " is void as a variable.\n")
+		    (princ " is void as a variable.")
 		  (princ "'s "))))
 	    (if valvoid
 		nil
 	      (with-current-buffer standard-output
 		(setq val-start-pos (point))

Mercurial > emacs

comparison lisp/help-fns.el @ 90261:7beb78bc1f8e