Org-mode mailing list
 help / color / mirror / Atom feed
From: "Nicholas Savage" <nick@nicksavage.ca>
To: "Emanuel Berg via General discussions about Org-mode."
	<emacs-orgmode@gnu.org>
Subject: [PATCH] (org-remove-occur-highlights) Implements option to remove highlights between points
Date: Sun, 20 Sep 2020 22:02:15 -0400
Message-ID: <b204da05-85f3-43af-bbf0-ed7149b300af@www.fastmail.com> (raw)

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

I realize now that I messed up sending this patch yesterday so it didn't show up on updates.orgmode.org. I just wanted to repost it with a correct subject to make sure it didn't get lost. My original message follows.

--

I posted earlier about why org-remove-occur-highlights ignored it's options of beg and end. I'm fairly sure it was so they could be implemented later. I wanted to use this functionality, so I've implemented it. This should not change any current behaviour. If beg and end are nil, it will run the same way as before. This is called as part of org-sparse-tree, and my changes do not affect that. When beg and end are non-nil, it checks which overlays are between those two points and deletes them. I've ensured that 'make test' still passes and believe I've formatted my changelog entry as required.

If I'm missing something about how this should be working, please let me know.

My copyright paperwork with FSF is currently in progress, but I wanted to put this out there to get comments as necessary.

Thanks,
Nick

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org.el-Implements-option-to-remove-highlights-betwee.patch --]
[-- Type: text/x-patch; name="0001-org.el-Implements-option-to-remove-highlights-betwee.patch", Size: 3044 bytes --]

From 3213a8d50af0a99be43bf1f91c5621a6474548dd Mon Sep 17 00:00:00 2001
From: nick <nick@nicksavage.ca>
Date: Thu, 17 Sep 2020 21:49:43 -0400
Subject: [PATCH] org.el: Implements option to remove highlights between points

* lisp/org.el (org-remove-occur-highlights): Implements BEG and END in
order to allow the option of removing highlights between a range of
points and adjust the shown context.

org-remove-occur-highlights has long had two options, BEG and END,
that were ignored. This change checks first 1) are BEG and END are
nil (as would be expected with the vast majority of current
behaviour)? If yes, there is no change in behaviour. Otherwise, it
removes only the highlights between BEG and END and updates
org-occur-highlights to contain the remaining highlights.
---
 lisp/org.el | 41 ++++++++++++++++++++++++++++++++---------
 1 file changed, 32 insertions(+), 9 deletions(-)

diff --git a/lisp/org.el b/lisp/org.el
index 053635c85..f509b8049 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -11106,18 +11106,41 @@ match is found."
     (overlay-put ov 'org-type 'org-occur)
     (push ov org-occur-highlights)))
 
-(defun org-remove-occur-highlights (&optional _beg _end noremove)
+(defun org-remove-occur-highlights (&optional beg end noremove)
   "Remove the occur highlights from the buffer.
-BEG and END are ignored.  If NOREMOVE is nil, remove this function
-from the `before-change-functions' in the current buffer."
+When BEG and END are set, removes the overlay and hides the items
+between those two points. It does this by going through each overlay
+and comparing whther or not they are within the two points. If BEG and
+END are not set, erases all overlays and sets related variables to
+nil. If NOREMOVE is nil, remove this function from the
+`before-change-functions' in the current buffer."
   (interactive)
   (unless org-inhibit-highlight-removal
-    (mapc #'delete-overlay org-occur-highlights)
-    (setq org-occur-highlights nil)
-    (setq org-occur-parameters nil)
-    (unless noremove
-      (remove-hook 'before-change-functions
-		   'org-remove-occur-highlights 'local))))
+    ; if only one of BEG and END are set, set both to nil
+    (when (or (and beg (not end)) (and (not beg) end))
+      (setq beg nil end nil))
+    (cond
+     ((and (not beg) (not end))
+      (mapc #'delete-overlay org-occur-highlights)
+      (setq org-occur-highlights nil)
+      (setq org-occur-parameters nil)
+      (unless noremove
+	(remove-hook 'before-change-functions
+		     'org-remove-occur-highlights 'local)))
+     ((> end beg)
+      (org-overview)
+      (setq temp-overlays '())
+      (dolist (overlay org-occur-highlights)
+	(let ((overlay-point (overlay-start overlay)))
+
+	  (if (and (> overlay-point beg) (< overlay-point end))
+	      (delete-overlay overlay)
+	    (progn
+	      (save-excursion
+		(goto-char overlay-point)
+		(org-show-set-visibility 'ancestors)
+		(add-to-list 'temp-overlays overlay))))))
+      (setq org-occur-highlights temp-overlays)))))
 
 ;;;; Priorities
 
-- 
2.20.1


             reply	other threads:[~2020-09-21  2:03 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-21  2:02 Nicholas Savage [this message]
2020-09-22  5:22 ` Kyle Meyer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://orgmode.org

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=b204da05-85f3-43af-bbf0-ed7149b300af@www.fastmail.com \
    --to=nick@nicksavage.ca \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link

Org-mode mailing list

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://orgmode.org/list/0 list/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 list list/ https://orgmode.org/list \
		emacs-orgmode@gnu.org
	public-inbox-index list

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.yhetil.org/yhetil.emacs.orgmode
	nntp://news.gmane.io/gmane.emacs.orgmode


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git