GNU bug report logs - #1222
overlay display inherits face properties from buffer

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 1222 in the body.
You can then email your comments to 1222 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #3 received at quiet <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: quiet <at> debbugs.gnu.org
Subject: overlay display inherits face properties from buffer
Date: Tue, 21 Oct 2008 20:57:56 -0400

Package: emacs
Version: 23.0.60
Severity: minor

This bug is extracted from #1176, which contained several issues.

The display property of an overlay inherits face properties from the
following buffer text. The workaround is to fully specify the face
properties of the display text.

Example:

(let ((buff (generate-new-buffer "overlay test"))
      o)
  (with-current-buffer buff
    (insert (propertize "text" 'face '(:background "red")))
    (setq o (make-overlay (point-min) (point-max)))
    (overlay-put o 'display "display")
;;;    (overlay-put o 'display (propertize "display" 'face 'default))
    (pop-to-buffer buff)))

"display" has a red background. The commented out part shows the
workaround.

Message #6 received at 1222-quiet <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: 1222-quiet <at> debbugs.gnu.org
Subject: Re: bug#1222: overlay display inherits face properties from buffer
Date: Tue, 21 Oct 2008 21:10:26 -0400

This issue also affects before- and after-strings, albeit in slightly
different ways:

Example:

(let ((buff (generate-new-buffer "overlay test"))
      o)
  (with-current-buffer buff
    (insert (propertize "text" 'face '(:background "red")))
    (setq o (make-overlay (point-min) (point-max)))
    (overlay-put o 'display "display")
    (overlay-put o 'before-string "before-string")
    (overlay-put o 'after-string "after-string")
    (insert (propertize "more" 'face '(:background "green")))
    (pop-to-buffer buff)))

"before-string" and "display" have a red background, "after-string"
has a green background.

Ideally, face properties should not be inherited from the buffer in
this way.

Message #9 received at 1222 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 1222 <at> debbugs.gnu.org
Subject: Re: bug#1222: overlay display inherits face properties from buffer
Date: Mon, 30 Sep 2019 09:01:13 +0200

Glenn Morris <rgm <at> gnu.org> writes:

> This issue also affects before- and after-strings, albeit in slightly
> different ways:
>
> Example:
>
> (let ((buff (generate-new-buffer "overlay test"))
>       o)
>   (with-current-buffer buff
>     (insert (propertize "text" 'face '(:background "red")))
>     (setq o (make-overlay (point-min) (point-max)))
>     (overlay-put o 'display "display")
>     (overlay-put o 'before-string "before-string")
>     (overlay-put o 'after-string "after-string")
>     (insert (propertize "more" 'face '(:background "green")))
>     (pop-to-buffer buff)))
>
> "before-string" and "display" have a red background, "after-string"
> has a green background.
>
> Ideally, face properties should not be inherited from the buffer in
> this way.

Hm...  is this the same as bug#25348?  If so, it was decided there that
this was behaviour as designed, I think.

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

Message #12 received at 1222 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: rgm <at> gnu.org, 1222 <at> debbugs.gnu.org
Subject: Re: bug#1222: overlay display inherits face properties from buffer
Date: Mon, 30 Sep 2019 10:44:50 +0300

tags 1222 notabug
thanks

> From: Lars Ingebrigtsen <larsi <at> gnus.org>
> Date: Mon, 30 Sep 2019 09:01:13 +0200
> Cc: 1222 <at> debbugs.gnu.org
> 
> Glenn Morris <rgm <at> gnu.org> writes:
> 
> > This issue also affects before- and after-strings, albeit in slightly
> > different ways:
> >
> > Example:
> >
> > (let ((buff (generate-new-buffer "overlay test"))
> >       o)
> >   (with-current-buffer buff
> >     (insert (propertize "text" 'face '(:background "red")))
> >     (setq o (make-overlay (point-min) (point-max)))
> >     (overlay-put o 'display "display")
> >     (overlay-put o 'before-string "before-string")
> >     (overlay-put o 'after-string "after-string")
> >     (insert (propertize "more" 'face '(:background "green")))
> >     (pop-to-buffer buff)))
> >
> > "before-string" and "display" have a red background, "after-string"
> > has a green background.
> >
> > Ideally, face properties should not be inherited from the buffer in
> > this way.
> 
> Hm...  is this the same as bug#25348?  If so, it was decided there that
> this was behaviour as designed, I think.

No, it isn't related to bug#25348.  But it's "as designed"
nonetheless: the display engine always merges all the sources of the
face information relevant to the current buffer position.  This is
documented in the ELisp manual, see the beginning of the node
"Displaying Faces" (I believe this wasn't documented at the time this
bug was filed).

IOW, what is reported here is the expected behavior, that's how the
code was designed and implemented.

P.S. The original report says "inherits face properties from the
following buffer text", but the "following" part is only accurate when
referring to how text appears on display.  The Lisp code in the report
clearly puts the red background on the text "covered" by the overlay,
so that background affects the buffer position(s) where the overlay is
set up.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.