Mercurial > emacs
changeset 65470:a6481386d6b6
(describe-variable): Rearrange to put source link in a predictable place.
| author | Richard M. Stallman <rms@gnu.org> |
|---|---|
| date | Mon, 12 Sep 2005 15:35:22 +0000 |
| parents | ba050fdb5000 |
| children | 28d7d90409ee |
| files | lisp/help-fns.el |
| diffstat | 1 files changed, 110 insertions(+), 106 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/help-fns.el Mon Sep 12 15:33:35 2005 +0000 +++ b/lisp/help-fns.el Mon Sep 12 15:35:22 2005 +0000 @@ -522,108 +522,13 @@ (let* ((valvoid (not (with-current-buffer buffer (boundp variable)))) ;; Extract the value before setting up the output buffer, ;; in case `buffer' *is* the output buffer. - (val (unless valvoid (buffer-local-value variable buffer)))) + (val (unless valvoid (buffer-local-value variable buffer))) + val-start-pos) (help-setup-xref (list #'describe-variable variable buffer) (interactive-p)) (with-output-to-temp-buffer (help-buffer) (with-current-buffer buffer (prin1 variable) - (if valvoid - (princ " is void") - (with-current-buffer standard-output - (princ "'s value is ") - (terpri) - (let ((from (point))) - (pp val) - ;; Hyperlinks in variable's value are quite frequently - ;; inappropriate e.g C-h v <RET> features <RET> - ;; (help-xref-on-pp from (point)) - (if (< (point) (+ from 20)) - (delete-region (1- from) from))))) - (terpri) - (when (local-variable-p variable) - (princ (format "%socal in buffer %s; " - (if (get variable 'permanent-local) - "Permanently l" "L") - (buffer-name))) - (if (not (default-boundp variable)) - (princ "globally void") - (let ((val (default-value variable))) - (with-current-buffer standard-output - (princ "global value is ") - (terpri) - ;; Fixme: pp can take an age if you happen to - ;; ask for a very large expression. We should - ;; probably print it raw once and check it's a - ;; sensible size before prettyprinting. -- fx - (let ((from (point))) - (pp val) - ;; See previous comment for this function. - ;; (help-xref-on-pp from (point)) - (if (< (point) (+ from 20)) - (delete-region (1- from) from)))))) - (terpri)) - (terpri) - (with-current-buffer standard-output - (when (> (count-lines (point-min) (point-max)) 10) - ;; Note that setting the syntax table like below - ;; makes forward-sexp move over a `'s' at the end - ;; of a symbol. - (set-syntax-table emacs-lisp-mode-syntax-table) - (goto-char (point-min)) - (if valvoid - (forward-line 1) - (forward-sexp 1) - (delete-region (point) (progn (end-of-line) (point))) - (save-excursion - (insert "\n\nValue:") - (set (make-local-variable 'help-button-cache) - (point-marker))) - (insert " value is shown ") - (insert-button "below" - 'action help-button-cache - 'follow-link t - 'help-echo "mouse-2, RET: show value") - (insert ".\n\n"))) - ;; Add a note for variables that have been make-var-buffer-local. - (when (and (local-variable-if-set-p variable) - (or (not (local-variable-p variable)) - (with-temp-buffer - (local-variable-if-set-p variable)))) - (save-excursion - (forward-line -1) - (insert "Automatically becomes buffer-local when set in any fashion.\n")))) - ;; Mention if it's an alias - (let* ((alias (condition-case nil - (indirect-variable variable) - (error variable))) - (obsolete (get variable 'byte-obsolete-variable)) - (doc (or (documentation-property variable 'variable-documentation) - (documentation-property alias 'variable-documentation)))) - (unless (eq alias variable) - (princ (format "This variable is an alias for `%s'." alias)) - (terpri) - (terpri)) - (when obsolete - (princ "This variable is obsolete") - (if (cdr obsolete) (princ (format " since %s" (cdr obsolete)))) - (princ ";") (terpri) - (princ (if (stringp (car obsolete)) (car obsolete) - (format "use `%s' instead." (car obsolete)))) - (terpri) - (terpri)) - (princ (or doc "Not documented as a variable."))) - ;; Make a link to customize if this variable can be customized. - (if (custom-variable-p variable) - (let ((customize-label "customize")) - (terpri) - (terpri) - (princ (concat "You can " customize-label " this variable.")) - (with-current-buffer standard-output - (save-excursion - (re-search-backward - (concat "\\(" customize-label "\\)") nil t) - (help-xref-button 1 'help-customize-variable 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.) @@ -647,16 +552,115 @@ (if (get-buffer " *DOC*") (help-C-file-name variable 'var) 'C-source))) - (when file-name - (princ "\n\nDefined in `") - (princ (if (eq file-name 'C-source) "C source code" file-name)) - (princ "'.") - (with-current-buffer standard-output - (save-excursion - (re-search-backward "`\\([^`']+\\)'" nil t) - (help-xref-button 1 'help-variable-def - variable file-name))))) + (if file-name + (progn + (princ " is a variable defined in `") + (princ (if (eq file-name 'C-source) "C source code" file-name)) + (princ "'.\n") + (with-current-buffer standard-output + (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 "Its "))) + (if valvoid + (princ " is void as a variable.\n") + (princ "'s ")))) + (if valvoid + nil + (with-current-buffer standard-output + (setq val-start-pos (point)) + (princ "value is ") + (terpri) + (let ((from (point))) + (pp val) + ;; Hyperlinks in variable's value are quite frequently + ;; inappropriate e.g C-h v <RET> features <RET> + ;; (help-xref-on-pp from (point)) + (if (< (point) (+ from 20)) + (delete-region (1- from) from))))) + (terpri) + (when (local-variable-p variable) + (princ (format "%socal in buffer %s; " + (if (get variable 'permanent-local) + "Permanently l" "L") + (buffer-name))) + (if (not (default-boundp variable)) + (princ "globally void") + (let ((val (default-value variable))) + (with-current-buffer standard-output + (princ "global value is ") + (terpri) + ;; Fixme: pp can take an age if you happen to + ;; ask for a very large expression. We should + ;; probably print it raw once and check it's a + ;; sensible size before prettyprinting. -- fx + (let ((from (point))) + (pp val) + ;; See previous comment for this function. + ;; (help-xref-on-pp from (point)) + (if (< (point) (+ from 20)) + (delete-region (1- from) from))))))) + ;; Add a note for variables that have been make-var-buffer-local. + (when (and (local-variable-if-set-p variable) + (or (not (local-variable-p variable)) + (with-temp-buffer + (local-variable-if-set-p variable)))) + (princ "\nAutomatically becomes buffer-local when set in any fashion.\n")) + (terpri) + + ;; If the value is large, move it to the end. + (with-current-buffer standard-output + (when (> (count-lines (point-min) (point-max)) 10) + ;; Note that setting the syntax table like below + ;; makes forward-sexp move over a `'s' at the end + ;; of a symbol. + (set-syntax-table emacs-lisp-mode-syntax-table) + (goto-char val-start-pos) + (delete-region (point) (progn (end-of-line) (point))) + (save-excursion + (insert "\n\nValue:") + (set (make-local-variable 'help-button-cache) + (point-marker))) + (insert "value is shown ") + (insert-button "below" + 'action help-button-cache + 'follow-link t + 'help-echo "mouse-2, RET: show value") + (insert ".\n\n"))) + + ;; Mention if it's an alias + (let* ((alias (condition-case nil + (indirect-variable variable) + (error variable))) + (obsolete (get variable 'byte-obsolete-variable)) + (doc (or (documentation-property variable 'variable-documentation) + (documentation-property alias 'variable-documentation)))) + (unless (eq alias variable) + (princ (format "\nThis variable is an alias for `%s'.\n" alias))) + (when obsolete + (princ "\nThis variable is obsolete") + (if (cdr obsolete) (princ (format " since %s" (cdr obsolete)))) + (princ ";") (terpri) + (princ (if (stringp (car obsolete)) (car obsolete) + (format "use `%s' instead." (car obsolete)))) + (terpri)) + (princ "Documentation:\n") + (princ (or doc "Not documented as a variable."))) + ;; Make a link to customize if this variable can be customized. + (if (custom-variable-p variable) + (let ((customize-label "customize")) + (terpri) + (terpri) + (princ (concat "You can " customize-label " this variable.")) + (with-current-buffer standard-output + (save-excursion + (re-search-backward + (concat "\\(" customize-label "\\)") nil t) + (help-xref-button 1 'help-customize-variable variable))))) (print-help-return-message) (save-excursion (set-buffer standard-output)