Add xref-edit-mode (bug#80616)

Based on the existing grep-edit-mode code.

* lisp/progmodes/xref.el (xref-edit--prepare-buffer): New function.
(xref-edit-mode-map, xref-edit-mode-hook): New variables.
(xref-edit-mode, xref-change-to-xref-edit-mode)
(xref-edit-save-changes): New functions.
(xref--xref-buffer-mode-map): New binding ("e").

* doc/emacs/maintaining.texi (Identifier Search):
Mention xref-change-to-xref-edit-mode.

* etc/NEWS: Describe the addition.

3 files changed, 102 insertions, 0 deletions

diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi
index 4aee5e1045d..72f25c0bdf8 100644
--- a/doc/emacs/maintaining.texi
+++ b/doc/emacs/maintaining.texi
@@ -2926,6 +2926,16 @@ matches of that regexp in the names of the identifiers with
 @code{xref-query-replace-in-results}, but is more convenient when you
 want to rename a single identifier specified by its name @var{from}.
 
+@findex xref-change-to-xref-edit-mode
+@cindex Xref Edit mode
+@cindex mode, Xref Edit
+  Typing @kbd{e} in the @file{*xref*} buffer makes the buffer writable
+and enters the Xref Edit mode.  Similar to Occur Edit mode (@pxref{Other
+Repeating Search}), you can edit the matching lines reported by
+Xref backend and have those changes reflected in the buffer visiting the
+originating file.  Type @kbd{C-c C-c} to leave the Xref Edit mode and
+return to the Xref mode.
+
 @findex tags-search
   @kbd{M-x tags-search} reads a regexp using the minibuffer, then
 searches for matches in all the files in the selected tags table, one
diff --git a/etc/NEWS b/etc/NEWS
index 2b4e81fee14..335778d248a 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -3202,6 +3202,11 @@ This minor mode binds 'xref-find-definitions-at-mouse' to
 definition, following the convention from other editors.  The global
 minor mode 'global-xref-mouse-mode' will enable this in all buffers.
 
++++
+*** New command 'xref-change-to-xref-edit-mode'.
+It's bound to "e" and it switches an Xref buffer into an "editable" mode
+like similar features in Occur and Grep buffers.
+
 ** Revert
 
 +++
diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el
index ebf8df9f795..b69a4c7fdde 100644
--- a/lisp/progmodes/xref.el
+++ b/lisp/progmodes/xref.el
@@ -73,6 +73,7 @@
 (require 'cl-lib)
 (require 'ring)
 (require 'project)
+(require 'text-property-search)
 
 (eval-and-compile
   (when (version< emacs-version "28.0.60")
@@ -1004,6 +1005,7 @@ point."
     (define-key map (kbd ".") #'xref-next-line)
     (define-key map (kbd ",") #'xref-prev-line)
     (define-key map (kbd "M-,") #'xref-quit-and-pop-marker-stack)
+    (define-key map (kbd "e") #'xref-change-to-xref-edit-mode)
     map))
 
 (declare-function outline-search-text-property "outline"
@@ -1471,6 +1473,91 @@ between them by typing in the minibuffer with completion."
   'xref--show-defs-minibuffer #'xref-show-definitions-completing-read "28.1")
 
 
+(defun xref-edit--prepare-buffer ()
+  "Mark relevant regions read-only, and add relevant occur text-properties."
+  (save-excursion
+    (goto-char (point-min))
+    (let ((inhibit-read-only t)
+          match)
+      (while (setq match (text-property-search-forward 'xref-group))
+        (add-text-properties (prop-match-beginning match) (prop-match-end match)
+                             '(read-only t)))
+      (goto-char (point-min))
+      (while (setq match (text-property-search-forward 'xref-item))
+        (let ((line-number-end (save-excursion
+                                 (forward-line 0)
+                                 (and (looking-at " *[0-9]+:")
+                                      (match-end 0))))
+              (m (xref-location-marker (xref-item-location (prop-match-value match )))))
+          (when line-number-end
+            (add-text-properties (prop-match-beginning match) line-number-end
+                                 '(read-only t occur-prefix t)))
+          (add-text-properties (prop-match-beginning match)
+                               (1+ (pos-eol))
+                               `(occur-target ((,m . ,m)))))))))
+
+(defvar xref-edit-mode-map
+  (let ((map (make-sparse-keymap)))
+    (define-key map (kbd "C-c C-c") #'xref-edit-save-changes)
+    (define-key map (kbd "RET") #'xref-goto-xref)
+    (define-key map (kbd "M-,") #'xref-quit-and-pop-marker-stack)
+    (define-key map (kbd "C-o") #'xref-show-location-at-point)
+    map)
+  "Keymap for `xref-edit-mode'.")
+
+(defvar xref-edit-mode-hook nil
+  "Hooks run when changing to Xref-Edit mode.")
+
+(defun xref-edit-mode ()
+  "Major mode for editing *xref* buffers.
+In this mode, changes to the *xref* buffer are applied to the
+originating files.
+\\<xref-edit-mode-map>
+Type \\[xref-edit-save-changes] to exit Xref-Edit mode, return to Xref
+mode.
+
+The only editable texts in an Xref-Edit buffer are the match results."
+  (interactive)
+  (error "This mode can be enabled only by `xref-change-to-xref-edit-mode'"))
+(put 'xref-edit-mode 'mode-class 'special)
+
+(defun xref-change-to-xref-edit-mode ()
+  "Switch to `xref-edit-mode' to edit *xref* buffer."
+  (interactive)
+  (unless (derived-mode-p 'xref--xref-buffer-mode)
+    (error "Not an Xref buffer"))
+  (use-local-map xref-edit-mode-map)
+  (xref-edit--prepare-buffer)
+  (setq buffer-read-only nil)
+  (setq major-mode 'xref-edit-mode)
+  (setq mode-name "Xref-Edit")
+  (buffer-enable-undo)
+  (set-buffer-modified-p nil)
+  (setq buffer-undo-list nil)
+  (add-hook 'after-change-functions #'occur-after-change-function nil t)
+  (run-mode-hooks 'xref-edit-mode-hook)
+  (message (substitute-command-keys
+            "Editing: Type \\[xref-edit-save-changes] to return to Xref mode")))
+
+(defun xref-edit-save-changes ()
+  "Switch back to Xref mode."
+  (interactive)
+  (unless (derived-mode-p 'xref-edit-mode)
+    (error "Not a Xref-Edit buffer"))
+  (remove-hook 'after-change-functions #'occur-after-change-function t)
+  (use-local-map xref--xref-buffer-mode-map)
+  (setq buffer-read-only t)
+  (setq major-mode 'xref--xref-buffer-mode)
+  (setq mode-name "XREF")
+  (force-mode-line-update)
+  (buffer-disable-undo)
+  (setq buffer-undo-list t)
+  (let ((inhibit-read-only t))
+    (remove-text-properties (point-min) (point-max)
+                            '(occur-target nil occur-prefix nil)))
+  (message "Switching to Xref mode"))
+
+
 (defcustom xref-show-xrefs-function 'xref--show-xref-buffer
   "Function to display a list of search results.