[PATCH] org-refile: calculate file part of the outline path outside the loop for the headings

[Sacha Chua <sacha@sachachua.com>]

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

Hello, all!

I noticed that org-refile-get-targets seems to recalculate the first
part of the outline path for each heading, which makes it slow on large
files when org-refile-use-outline-path is set to 'title. The following
patch let-binds that part to a variable that can be put outside the loop
for the headings, making it faster in the case where refile targets
include a few files with lots of headings. Does it make sense? I was
wondering if I was missing some important reason for it to be inside
that loop.

It feels like a pretty small change (just adding a let), but I 
have copyright assignment papers on file at the FSF just in case.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-org-refile-calculate-file-part-of-the-outline-path-o.patch --]
[-- Type: text/x-diff, Size: 4700 bytes --]

From 85a68b44cb3ddc5eda2dfe36614fdd6fb0755f6f Mon Sep 17 00:00:00 2001
From: Sacha Chua <sacha@sachachua.com>
Date: Sun, 13 Oct 2024 21:30:29 -0400
Subject: [PATCH] org-refile: calculate file part of the outline path once per
 file

* lisp/org-refile.el (org-refile-get-targets): Calculate the file part
of the outline path once per file, improving the performance when
org-refile-use-outline-path is set to 'title.
---
 lisp/org-refile.el | 89 +++++++++++++++++++++++-----------------------
 1 file changed, 44 insertions(+), 45 deletions(-)

diff --git a/lisp/org-refile.el b/lisp/org-refile.el
index 6da5f6482..7189f91a0 100644
--- a/lisp/org-refile.el
+++ b/lisp/org-refile.el
@@ -338,53 +338,52 @@ defun org-refile-get-targets
                                  (and f (file-name-nondirectory f)))
                              f nil nil)
                        tgs))
-	       (org-with-wide-buffer
-		(goto-char (point-min))
-		(setq org-outline-path-cache nil)
-		(while (re-search-forward descre nil t)
-		  (forward-line 0)
-		  (let ((case-fold-search nil))
-		    (looking-at org-complex-heading-regexp))
-		  (let ((begin (point))
-			(heading (match-string-no-properties 4)))
-		    (unless (or (and
-				 org-refile-target-verify-function
-				 (not
-				  (funcall org-refile-target-verify-function)))
-				(not heading))
-		      (let ((re (format org-complex-heading-regexp-format
-					(regexp-quote heading)))
-			    (target
-			     (if (not org-refile-use-outline-path) heading
-			       (mapconcat
-				#'identity
-				(append
-				 (pcase org-refile-use-outline-path
-				   (`file (list
+               (org-with-wide-buffer
+		(let ((base (pcase org-refile-use-outline-path
+			      (`file (list
+                                      (and (buffer-file-name (buffer-base-buffer))
+                                           (file-name-nondirectory
+                                            (buffer-file-name (buffer-base-buffer))))))
+                              (`title (list
+                                       (or (org-get-title)
                                            (and (buffer-file-name (buffer-base-buffer))
                                                 (file-name-nondirectory
-                                                 (buffer-file-name (buffer-base-buffer))))))
-                                   (`title (list
-                                            (or (org-get-title)
-                                                (and (buffer-file-name (buffer-base-buffer))
-                                                     (file-name-nondirectory
-                                                      (buffer-file-name (buffer-base-buffer)))))))
-                                   (`full-file-path
-				    (list (buffer-file-name
-					   (buffer-base-buffer))))
-				   (`buffer-name
-				    (list (buffer-name
-					   (buffer-base-buffer))))
-				   (_ nil))
-				 (mapcar (lambda (s) (replace-regexp-in-string
-						 "/" "\\/" s nil t))
-					 (org-get-outline-path t t)))
-				"/"))))
-			(push (list target f re (org-refile-marker (point)))
-			      tgs)))
-		    (when (= (point) begin)
-		      ;; Verification function has not moved point.
-		      (end-of-line)))))))
+                                                 (buffer-file-name (buffer-base-buffer)))))))
+                              (`full-file-path
+			       (list (buffer-file-name
+				      (buffer-base-buffer))))
+			      (`buffer-name
+			       (list (buffer-name
+				      (buffer-base-buffer))))
+			      (_ nil))))
+		  (while (re-search-forward descre nil t)
+		    (forward-line 0)
+		    (let ((case-fold-search nil))
+		      (looking-at org-complex-heading-regexp))
+		    (let ((begin (point))
+			  (heading (match-string-no-properties 4)))
+		      (unless (or (and
+				   org-refile-target-verify-function
+				   (not
+				    (funcall org-refile-target-verify-function)))
+				  (not heading))
+		        (let ((re (format org-complex-heading-regexp-format
+					  (regexp-quote heading)))
+			      (target
+			       (if (not org-refile-use-outline-path) heading
+			         (mapconcat
+				  #'identity
+				  (append
+				   base
+				   (mapcar (lambda (s) (replace-regexp-in-string
+						        "/" "\\/" s nil t))
+					   (org-get-outline-path t t)))
+				  "/"))))
+			  (push (list target f re (org-refile-marker (point)))
+			        tgs)))
+		      (when (= (point) begin)
+		        ;; Verification function has not moved point.
+		        (end-of-line))))))))
 	    (when org-refile-use-cache
 	      (org-refile-cache-put tgs (buffer-file-name) descre))
 	    (setq targets (append tgs targets))))))
-- 
2.43.0


[-- Attachment #3: Type: text/plain, Size: 22 bytes --]


Best regards,

Sacha