bug#51606: 29.0.50; [PATCH] Show offscreen context with properties

bug#51606: 29.0.50; [PATCH] Show offscreen context with properties

[Arash Esbati]

Hi all,

paren.el now can show the context in minibuffer when
`show-paren-context-when-offscreen' is non-nil (introduced in this
change 9f505c476e).  Is it possible to extend this that text properties
are not stripped?  I'm thinking about something like this:

--8<---------------cut here---------------start------------->8---
diff --git a/lisp/paren.el b/lisp/paren.el
index 7e7cf6c262..d0330f2f6a 100644
--- a/lisp/paren.el
+++ b/lisp/paren.el
@@ -96,6 +96,14 @@ show-paren-context-when-offscreen
   :type 'boolean
   :version "29.1")

+(defcustom show-paren-context-when-offscreen-with-properties nil
+  "If non-nil, show the offscreen context in the echo area with properties.
+It is complementary to `show-paren-context-when-offscreen' and is
+taken into account when `show-paren-context-when-offscreen' is
+non-nil."
+  :type 'boolean
+  :version "29.1")
+
 (defvar show-paren--idle-timer nil)
 (defvar show-paren--overlay
   (let ((ol (make-overlay (point) (point) nil t))) (delete-overlay ol) ol)
@@ -332,7 +340,9 @@ show-paren-function
                       (message-log-max nil))
                   (minibuffer-message
                    "Matches %s"
-                   (substring-no-properties open-paren-line-string)))))
+                   (if show-paren-context-when-offscreen-with-properties
+                       open-paren-line-string
+                     (substring-no-properties open-paren-line-string))))))
           ;; Always set the overlay face, since it varies.
           (overlay-put show-paren--overlay 'priority show-paren-priority)
           (overlay-put show-paren--overlay 'face face))))))
--8<---------------cut here---------------end--------------->8---

Any comments welcome.  I will prepare a proper format-patch (incl. update of
programs.texi) once this is accepted.

Best, Arash

bug#51606: 29.0.50; [PATCH] Show offscreen context with properties

[Eli Zaretskii]

> From: Arash Esbati <arash@gnu.org>
> Date: Fri, 05 Nov 2021 10:40:47 +0100
> 
> paren.el now can show the context in minibuffer when
> `show-paren-context-when-offscreen' is non-nil (introduced in this
> change 9f505c476e).  Is it possible to extend this that text properties
> are not stripped?  I'm thinking about something like this:

Why do we remove the properties in the first place?  Daniel, any
special reasons?

bug#51606: 29.0.50; [PATCH] Show offscreen context with properties

[Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eli Zaretskii <eliz@gnu.org> writes:

>> From: Arash Esbati <arash@gnu.org>
>> Date: Fri, 05 Nov 2021 10:40:47 +0100
>> 
>> paren.el now can show the context in minibuffer when
>> `show-paren-context-when-offscreen' is non-nil (introduced in this
>> change 9f505c476e).  Is it possible to extend this that text properties
>> are not stripped?  I'm thinking about something like this:
>
> Why do we remove the properties in the first place?  Daniel, any
> special reasons?

No reason other than being cautious and "follow the traditional behavior
of blink-matching-open".  The code that I extracted from
blink-matching-open to reuse it for show-paren-mode removed the text
properties (see
https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/simple.el?h=emacs-28#n8608).
If I'm not mistaken, this was apparently introduced in 2005 by Richard
Stallman
(https://git.savannah.gnu.org/cgit/emacs.git/commit/?h=emacs-28&id=1d0e3fc84f058248515f242c0484a0dabfac95aa),
but I don't know the reasons for the change.  Perhaps it didn't look
good on some TTY frames?

bug#51606: 29.0.50; [PATCH] Show offscreen context with properties

[Eli Zaretskii]

> From: Daniel Martín <mardani29@yahoo.es>
> Cc: Arash Esbati <arash@gnu.org>,  51606@debbugs.gnu.org
> Date: Fri, 05 Nov 2021 13:57:08 +0100
> 
> >> paren.el now can show the context in minibuffer when
> >> `show-paren-context-when-offscreen' is non-nil (introduced in this
> >> change 9f505c476e).  Is it possible to extend this that text properties
> >> are not stripped?  I'm thinking about something like this:
> >
> > Why do we remove the properties in the first place?  Daniel, any
> > special reasons?
> 
> No reason other than being cautious and "follow the traditional behavior
> of blink-matching-open".  The code that I extracted from
> blink-matching-open to reuse it for show-paren-mode removed the text
> properties (see
> https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/simple.el?h=emacs-28#n8608).
> If I'm not mistaken, this was apparently introduced in 2005 by Richard
> Stallman
> (https://git.savannah.gnu.org/cgit/emacs.git/commit/?h=emacs-28&id=1d0e3fc84f058248515f242c0484a0dabfac95aa),
> but I don't know the reasons for the change.  Perhaps it didn't look
> good on some TTY frames?

I'd be surprised.

Richard, do you remember why you removed text properties from the
blink-matching-open text it shows in the echo-area?

bug#51606: 29.0.50; [PATCH] Show offscreen context with properties

[Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Eli Zaretskii <eliz@gnu.org> writes:

>> >
>> > Why do we remove the properties in the first place?  Daniel, any
>> > special reasons?
>> 
>> No reason other than being cautious and "follow the traditional behavior
>> of blink-matching-open".  The code that I extracted from
>> blink-matching-open to reuse it for show-paren-mode removed the text
>> properties (see
>> https://git.savannah.gnu.org/cgit/emacs.git/tree/lisp/simple.el?h=emacs-28#n8608).
>> If I'm not mistaken, this was apparently introduced in 2005 by Richard
>> Stallman
>> (https://git.savannah.gnu.org/cgit/emacs.git/commit/?h=emacs-28&id=1d0e3fc84f058248515f242c0484a0dabfac95aa),
>> but I don't know the reasons for the change.  Perhaps it didn't look
>> good on some TTY frames?
>
> I'd be surprised.
>
> Richard, do you remember why you removed text properties from the
> blink-matching-open text it shows in the echo-area?

BTW, the patch looks good to me.  But if keeping the text properties is
not a problem, I'd do that unconditionally, without adding another
customization option.  WDYT?

bug#51606: 29.0.50; [PATCH] Show offscreen context with properties

[Arash Esbati]

Daniel Martín <mardani29@yahoo.es> writes:

> Eli Zaretskii <eliz@gnu.org> writes:
>
>> I'd be surprised.
>>
>> Richard, do you remember why you removed text properties from the
>> blink-matching-open text it shows in the echo-area?
>
> BTW, the patch looks good to me.  But if keeping the text properties is
> not a problem, I'd do that unconditionally, without adding another
> customization option.  WDYT?

My vote is to drop my patch and keep the properties.  Emacs 29 dev cycle
is not old, we can apply my patch or revert the change if complaints
arrive.

Best, Arash

bug#51606: 29.0.50; [PATCH] Show offscreen context with properties

[Lars Ingebrigtsen]

Arash Esbati <arash@gnu.org> writes:

> My vote is to drop my patch and keep the properties. 

OK; now done in Emacs 29.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no