mirrors/emacs
1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-06 06:20:55 -08:00
Code Issues Projects Releases Wiki Activity

Prevent button.el from clearing help-echo strings

Browse source 
In order to fix one of the issues discussed in bug#61413, i.e.
'buttonize' clobbering the help-echo property set by
'icon-string'.

This is a reasonable interpretation of the button.el
docstrings - "if HELP-ECHO, use that as the `help-echo'
property"; conversely, if not HELP-ECHO, then do not do
anything, preserving existing values for that property.

* lisp/button.el (button--properties): Only add a help-echo
property if HELP-ECHO is non-nil.  Add an additional property
for bookkeeping.
(unbuttonize-region): Check for that bookkeeping property
before clearing help-echo.
* test/lisp/button-tests.el (button--preserve-help-echo):
Validate these changes.
This commit is contained in:
Kévin Le Gouguec 2025-02-20 22:37:13 +01:00
parent 269d337f91
commit f23ee93250
2 changed files with 49 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

18
lisp/button.el
View file

@ -652,15 +652,19 @@ Also see `buttonize-region'."
string)) string))
(defun button--properties (callback data help-echo) (defun button--properties (callback data help-echo)
(append
(list 'font-lock-face 'button (list 'font-lock-face 'button
'mouse-face 'highlight 'mouse-face 'highlight
'help-echo help-echo
'button t 'button t
'follow-link t 'follow-link t
'category t 'category t
'button-data data 'button-data data
'keymap button-map 'keymap button-map
'action callback)) 'action callback)
(and help-echo
(list 'help-echo help-echo
;; Record that button.el is responsible for this property.
'help-echo-button t))))
(defun buttonize-region (start end callback &optional data help-echo) (defun buttonize-region (start end callback &optional data help-echo)
"Make the region between START and END into a button. "Make the region between START and END into a button.
@ -681,8 +685,14 @@ This removes both text-property and overlay based buttons."
(when (overlay-get o 'button) (when (overlay-get o 'button)
(delete-overlay o))) (delete-overlay o)))
(with-silent-modifications (with-silent-modifications
(remove-text-properties start end (remove-text-properties
(button--properties nil nil nil)) start end
(append
(button--properties nil nil nil)
;; Only remove help-echo if it was added by button.el.
(and (get-text-property start 'help-echo-button)
(list 'help-echo nil
'help-echo-button nil))))
(add-face-text-property start end (add-face-text-property start end
'button nil))) 'button nil)))

28
test/lisp/button-tests.el
View file

@ -101,4 +101,32 @@
(setq button (insert-button "overlay" 'help-echo help)) (setq button (insert-button "overlay" 'help-echo help))
(should (equal (button--help-echo button) "overlay: x"))))) (should (equal (button--help-echo button) "overlay: x")))))
(ert-deftest button--preserve-help-echo ()
"Ensure buttonizing functions preserve existing `help-echo' properties."
;; buttonize.
(let* ((string (propertize "button text" 'help-echo "help text"))
(button (buttonize string #'ignore)))
(should (equal (get-text-property 0 'help-echo button)
"help text")))
;; buttonize-region.
(with-temp-buffer
(insert (propertize "button text" 'help-echo "help text"))
(buttonize-region (point-min) (point) #'ignore)
(should (equal (get-text-property (point-min) 'help-echo)
"help text"))
;; unbuttonize-region should not clear the property either.
(unbuttonize-region (point-min) (point))
(should (equal (get-text-property (point-min) 'help-echo)
"help text")))
;; unbuttonize-region should still clear properties applied with
;; buttonize.
(with-temp-buffer
(insert "button text")
(buttonize-region (point-min) (point) #'ignore nil "help text")
(should (equal (get-text-property (point-min) 'help-echo)
"help text"))
(unbuttonize-region (point-min) (point))
(should (equal (get-text-property (point-min) 'help-echo)
nil))))
;;; button-tests.el ends here ;;; button-tests.el ends here