unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#53155: Use overlays in hi-lock
@ 2022-01-10  8:17 Juri Linkov
  2022-01-13  9:08 ` Lars Ingebrigtsen
  0 siblings, 1 reply; 4+ messages in thread
From: Juri Linkov @ 2022-01-10  8:17 UTC (permalink / raw)
  To: 53155

[-- Attachment #1: Type: text/plain, Size: 810 bytes --]

When diff-refine overlays take precedence over hi-lock text properties,
then hi-lock can't be used to review diffs.  Hi-lock provides two modes:
font-lock highlighting and highlighting with overlays.  Using overlays
solves the problem.  But how to decide when overlays should be used?
Detecting whether the buffer is read-only, so no more text is expected
to be added to the buffer?  Then add overlays instead of using font-lock?
But this heuristics doesn't work in read-only *vc-change-log* buffers
where expanding commits inserts new text that should be highlighted
with font-lock.

Thus the following patch adds a new variable hi-lock-use-overlays
that can be used like:

#+begin_src emacs-lisp
(add-hook 'diff-mode-hook
            (lambda ()
              (setq-local hi-lock-use-overlays t)))
#+end_src


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: hi-lock-use-overlays.patch --]
[-- Type: text/x-diff, Size: 2035 bytes --]

diff --git a/lisp/hi-lock.el b/lisp/hi-lock.el
index fbd698e234..99e908ad07 100644
--- a/lisp/hi-lock.el
+++ b/lisp/hi-lock.el
@@ -738,6 +738,17 @@ hi-lock-read-face-name
       (add-to-list 'hi-lock-face-defaults face t))
     (intern face)))
 
+(defvar hi-lock-use-overlays nil
+  "Whether to always use overlays instead of font-lock rules.
+When font-lock-mode is enabled and the buffer specifies font-lock rules,
+highlighting is performed by adding new font-lock rules to the existing ones,
+so when new matching strings are added, they are highlighted by font-lock.
+Otherwise, overlays are used, but new highlighting overlays are not added
+when new matching strings are inserted to the buffer.
+However, sometimes overlays are still preferable even in buffers
+where font-lock is enabled, because hi-lock overlays take precedence
+over other overlays in the same buffer, such as diff-refine overlays, etc.")
+
 (defun hi-lock-set-pattern (regexp face &optional subexp lighter case-fold spaces-regexp)
   "Highlight SUBEXP of REGEXP with face FACE.
 If omitted or nil, SUBEXP defaults to zero, i.e. the entire
@@ -759,7 +770,8 @@ hi-lock-set-pattern
         (add-to-list 'hi-lock--unused-faces (face-name face))
       (push pattern hi-lock-interactive-patterns)
       (push (cons (or lighter regexp) pattern) hi-lock-interactive-lighters)
-      (if (and font-lock-mode (font-lock-specified-p major-mode))
+      (if (and font-lock-mode (font-lock-specified-p major-mode)
+               (not hi-lock-use-overlays))
 	  (progn
 	    (font-lock-add-keywords nil (list pattern) t)
 	    (font-lock-flush))
@@ -781,6 +793,7 @@ hi-lock-set-pattern
                                            (match-end subexp))))
                 (overlay-put overlay 'hi-lock-overlay t)
                 (overlay-put overlay 'hi-lock-overlay-regexp (or lighter regexp))
+                (overlay-put overlay 'priority 1)
                 (overlay-put overlay 'face face))
               (goto-char (match-end 0)))
             (when no-matches

^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#53155: Use overlays in hi-lock
  2022-01-10  8:17 bug#53155: Use overlays in hi-lock Juri Linkov
@ 2022-01-13  9:08 ` Lars Ingebrigtsen
  2022-01-24 19:17   ` Juri Linkov
  0 siblings, 1 reply; 4+ messages in thread
From: Lars Ingebrigtsen @ 2022-01-13  9:08 UTC (permalink / raw)
  To: Juri Linkov; +Cc: 53155

Juri Linkov <juri@linkov.net> writes:

> But this heuristics doesn't work in read-only *vc-change-log* buffers
> where expanding commits inserts new text that should be highlighted
> with font-lock.
>
> Thus the following patch adds a new variable hi-lock-use-overlays
> that can be used like:

I guess that makes sense...

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





^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#53155: Use overlays in hi-lock
  2022-01-13  9:08 ` Lars Ingebrigtsen
@ 2022-01-24 19:17   ` Juri Linkov
  2022-01-25 11:59     ` Lars Ingebrigtsen
  0 siblings, 1 reply; 4+ messages in thread
From: Juri Linkov @ 2022-01-24 19:17 UTC (permalink / raw)
  To: Lars Ingebrigtsen; +Cc: 53155

close 53155 29.0.50
stop

>> But this heuristics doesn't work in read-only *vc-change-log* buffers
>> where expanding commits inserts new text that should be highlighted
>> with font-lock.
>>
>> Thus the following patch adds a new variable hi-lock-use-overlays
>> that can be used like:
>
> I guess that makes sense...

So now pushed to master and closed.  I'm not sure if the new
variable 'hi-lock-use-overlays' needs to be mentioned in NEWS.





^ permalink raw reply	[flat|nested] 4+ messages in thread

* bug#53155: Use overlays in hi-lock
  2022-01-24 19:17   ` Juri Linkov
@ 2022-01-25 11:59     ` Lars Ingebrigtsen
  0 siblings, 0 replies; 4+ messages in thread
From: Lars Ingebrigtsen @ 2022-01-25 11:59 UTC (permalink / raw)
  To: Juri Linkov; +Cc: 53155

Juri Linkov <juri@linkov.net> writes:

> So now pushed to master and closed.  I'm not sure if the new
> variable 'hi-lock-use-overlays' needs to be mentioned in NEWS.

No, probably not.

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





^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2022-01-25 11:59 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-01-10  8:17 bug#53155: Use overlays in hi-lock Juri Linkov
2022-01-13  9:08 ` Lars Ingebrigtsen
2022-01-24 19:17   ` Juri Linkov
2022-01-25 11:59     ` Lars Ingebrigtsen

Code repositories for project(s) associated with this inbox:

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).