emacs: lisp/help.el comparison

comparison lisp/help.el @ 32183:3e4bdf7c90c4

(help-xref-on-pp): Use match-string. (describe-variable): New arg BUFFER. Store the current buffer in the help-xref-stack. (temp-buffer-resize-mode): Use define-minor-mode.

author	Stefan Monnier <monnier@iro.umontreal.ca>
date	Thu, 05 Oct 2000 22:27:38 +0000
parents	080006769824
children	ab059a552fa2

comparison

equal deleted inserted replaced

-:f5d09b70a4b8
+:3e4bdf7c90c4
 (setq buffer-read-only nil))
 (add-hook 'temp-buffer-setup-hook 'help-mode-setup)
 (defun help-mode-finish ()
 (when (eq major-mode 'help-mode)
 ;; View mode's read-only status of existing *Help* buffer is lost
 ;; by with-output-to-temp-buffer.
 (toggle-read-only 1)
 (help-make-xrefs (current-buffer)))
 (setq view-return-to-alist
 	    (while (not (eobp))
 	      (cond
 	       ((looking-at "\"") (forward-sexp 1))
 	       ((looking-at "#<") (search-forward ">" nil 'move))
 	       ((looking-at "\\(\\(\\sw\\|\\s_\\)+\\)")
-		(let* ((sym (intern-soft
+		(let* ((sym (intern-soft (match-string 1)))
-			     (buffer-substring (match-beginning 1)
-					       (match-end 1))))
 		       (fn (cond ((fboundp sym) #'describe-function)
 				 ((or (memq sym '(t nil))
 				      (keywordp sym))
 				  nil)
 				 ((and sym (boundp sym))
 		  (when fn (help-xref-button 1 fn sym)))
 		(goto-char (match-end 1)))
 	       (t (forward-char 1))))))
 (set-syntax-table ost))))
-(defun describe-variable (variable)
+(defun describe-variable (variable &optional buffer)
 "Display the full documentation of VARIABLE (a symbol).
-Returns the documentation as a string, also."
+Returns the documentation as a string, also.
-(interactive
+If VARIABLE has a buffer-local value in BUFFER (default to the current buffer),
+it is displayed along with the global value."
+(interactive
 (let ((v (variable-at-point))
 	 (enable-recursive-minibuffers t)
 	 val)
 (setq val (completing-read (if (symbolp v)
 				    (format
 				  "Describe variable: ")
 				obarray 'boundp t nil nil
 				(if (symbolp v) (symbol-name v))))
 (list (if (equal val "")
 	       v (intern val)))))
-(if (symbolp variable)
+(unless (bufferp buffer) (setq buffer (current-buffer)))
-(let (valvoid)
+(if (not (symbolp variable))
+(message "You did not specify a variable")
+(let (valvoid)
+(with-current-buffer buffer
 	(with-output-to-temp-buffer "*Help*"
 	  (prin1 variable)
 	  (if (not (boundp variable))
 	      (progn
 		(princ " is void")
 		      (let ((from (point)))
 			(pp val)
 			(help-xref-on-pp from (point))))))
 		(terpri)))
 	  (terpri)
-	  (save-current-buffer
+	  (with-current-buffer standard-output
-	    (set-buffer standard-output)
 	    (if (> (count-lines (point-min) (point-max)) 10)
 		(progn
 		  ;; Note that setting the syntax table like below
 		  ;; makes forward-sexp move over a `'s' at the end
 		  ;; of a symbol.
 		      (insert "\n\nValue:"))))))
 	  (princ "Documentation:")
 	  (terpri)
 	  (let ((doc (documentation-property variable 'variable-documentation)))
 	    (princ (or doc "not documented as a variable.")))
-(help-setup-xref (list #'describe-variable variable) (interactive-p))
+(help-setup-xref (list #'describe-variable variable (current-buffer))
+			   (interactive-p))
 	  ;; Make a link to customize if this variable can be customized.
 	  ;; Note, it is not reliable to test only for a custom-type property
 	  ;; because those are only present after the var's definition
 	  ;; has been loaded.
 	  (if (or (get variable 'custom-type) ; after defcustom
 		(terpri)
 		(terpri)
 		(princ (concat "You can " customize-label " this variable."))
 		(with-current-buffer "*Help*"
 		  (save-excursion
 		    (re-search-backward
 		     (concat "\\(" customize-label "\\)") nil t)
 		    (help-xref-button 1 (lambda (v)
 					  (if help-xref-stack
 					      (pop help-xref-stack))
 					  (customize-variable v))
 	  (print-help-return-message)
 	  (save-excursion
 	    (set-buffer standard-output)
 	    ;; Return the text we displayed.
-	    (buffer-string))))
+	    (buffer-string)))))))
-(message "You did not specify a variable")))
 (defun describe-bindings (&optional prefix buffer)
 "Show a list of all defined keys, and their definitions.
 We put that list in a buffer, and display the buffer.
 			   "mouse-2, RET: describe this function"))
 			 ((facep sym)
 			  (help-xref-button
 			   7 #'describe-face sym)))))))
 ;; An obvious case of a key substitution:
 (save-excursion
 (while (re-search-forward
 			;; Assume command name is only word characters
 			;; and dashes to get things like `use M-x foo.'.
 "\\<M-x\\s-+\\(\\sw\\(\\sw\\|-\\)+\\)" nil t)
 (let ((sym (intern-soft (match-string 1))))
 (save-excursion
 		;; Make sure to find the first keymap.
 		(goto-char (point-min))
 ;; Find a header and the column at which the command
 ;; name will be found.
 (while (re-search-forward "^key +binding\n\\(-+ +\\)-+\n\n"
 nil t)
 (let ((col (- (match-end 1) (match-beginning 1))))
 (while
 ;; Ignore single blank lines in table, but not
 ;; double ones, which should terminate it.
 			       (skip-chars-backward "^\t\n")
 (if (and (>= (current-column) col)
 					(looking-at "\\(\\sw\\|-\\)+$"))
 (let ((sym (intern-soft (match-string 0))))
 (if (fboundp sym)
 (help-xref-button
 0 #'describe-function sym
 					  "mouse-2, RET: describe this function"))))
 			       (zerop (forward-line)))))))))
 (set-syntax-table stab))
 ;; Make a back-reference in this buffer if appropriate.
 	     (goto-char (point-max)))))))
 ;;; Automatic resizing of temporary buffers.
-(defcustom temp-buffer-resize-mode nil
-"Non-nil means resize windows displaying temporary buffers.
-This makes the window the right height for its contents, but never
-more than `temp-buffer-max-height' nor less than `window-min-height'.
-This applies to `help', `apropos' and `completion' buffers, and some others.
-Setting this variable directly does not take effect;
-use either \\[customize] or the function `temp-buffer-resize-mode'."
-:get (lambda (symbol)
-(and (memq 'resize-temp-buffer-window temp-buffer-show-hook) t))
-:set (lambda (symbol value)
-(temp-buffer-resize-mode (if value 1 -1)))
-:initialize 'custom-initialize-default
-:type 'boolean
-:group 'help
-:version "20.4")
 (defcustom temp-buffer-max-height (lambda (buffer) (/ (- (frame-height) 2) 2))
 "*Maximum height of a window displaying a temporary buffer.
 This is the maximum height (in text lines) which `resize-temp-buffer-window'
 will give to a window displaying a temporary buffer.
 It can also be a function which will be called with the object corresponding
 positive number."
 :type '(choice integer function)
 :group 'help
 :version "20.4")
-(defun temp-buffer-resize-mode (arg)
+(define-minor-mode temp-buffer-resize-mode
-"Toggle the mode which that makes windows smaller for temporary buffers.
+"Toggle the mode which makes windows smaller for temporary buffers.
 With prefix argument ARG, turn the resizing of windows displaying temporary
 buffers on if ARG is positive or off otherwise.
-See the documentation of the variable `temp-buffer-resize-mode' for
+This makes the window the right height for its contents, but never
-more information."
+more than `temp-buffer-max-height' nor less than `window-min-height'.
-(interactive "P")
+This applies to `help', `apropos' and `completion' buffers, and some others."
-(let ((turn-it-on
+nil nil nil :global t :group 'help
-(if (null arg)
+(if temp-buffer-resize-mode
-(not (memq 'resize-temp-buffer-window temp-buffer-show-hook))
+;; `help-mode-maybe' may add a `back' button and thus increase the
-(> (prefix-numeric-value arg) 0))))
+;; text size, so `resize-temp-buffer-window' must be run *after* it.
-(if turn-it-on
+(add-hook 'temp-buffer-show-hook 'resize-temp-buffer-window 'append)
-(progn
+(remove-hook 'temp-buffer-show-hook 'resize-temp-buffer-window))))
-;; `help-mode-maybe' may add a `back' button and thus increase the
-;; text size, so `resize-temp-buffer-window' must be run *after* it.
-(add-hook 'temp-buffer-show-hook 'resize-temp-buffer-window 'append)
-(setq temp-buffer-resize-mode t))
-(remove-hook 'temp-buffer-show-hook 'resize-temp-buffer-window)
-(setq temp-buffer-resize-mode nil))))
 (defun resize-temp-buffer-window ()
 "Resize the current window to fit its contents.
 Will not make it higher than `temp-buffer-max-height' nor smaller than
 `window-min-height'.  Do nothing if it is the only window on its frame, if it

Mercurial > emacs

comparison lisp/help.el @ 32183:3e4bdf7c90c4