Merge pull request #266 from ultronozm/ediff

Add Ediff support

Author: dgutov

diff-hl-show-hunk-inline.el

@@ -378,7 +378,7 @@ BUFFER is a buffer with the hunk."
              (when smart-lines
                (when (not (eq 0 original-lines-number))
                  original-lines-number)))
-            (footer "(q)Quit  (p)Previous  (n)Next  (r)Revert  (c)Copy original"))
+            (footer "(q)Quit  (p)Previous  (n)Next  (e)Ediff  (r)Revert  (c)Copy original"))
         (unless diff-hl-show-staged-changes
           (setq footer (concat footer " (S)Stage")))
         (diff-hl-show-hunk-inline-show

diff-hl-show-hunk-posframe.el

@@ -145,6 +145,11 @@ The button calls an ACTION."
     "Copy original (\\[diff-hl-show-hunk-copy-original-text])"
     #'diff-hl-show-hunk-copy-original-text)
 
+   (diff-hl-show-hunk--posframe-button
+    "⇄ Ediff"
+    "Ediff (\\[diff-hl-show-hunk-ediff])"
+    #'diff-hl-show-hunk-ediff)
+
    (diff-hl-show-hunk--posframe-button
     "♻ Revert hunk"
     "Revert hunk (\\[diff-hl-show-hunk-revert-hunk])"

diff-hl-show-hunk.el

@@ -220,6 +220,7 @@ Returns a list with the buffer and the line number of the clicked line."
     (define-key map (kbd "p") #'diff-hl-show-hunk-previous)
     (define-key map (kbd "n") #'diff-hl-show-hunk-next)
     (define-key map (kbd "c") #'diff-hl-show-hunk-copy-original-text)
+    (define-key map (kbd "e") #'diff-hl-show-hunk-ediff)
     (define-key map (kbd "r") #'diff-hl-show-hunk-revert-hunk)
     (define-key map (kbd "[") #'diff-hl-show-hunk-previous)
     (define-key map (kbd "]") #'diff-hl-show-hunk-next)
@@ -247,6 +248,12 @@ Returns a list with the buffer and the line number of the clicked line."
   (diff-hl-show-hunk-hide)
   (diff-hl-stage-current-hunk))
 
+(defun diff-hl-show-hunk-ediff ()
+  "Dismiss the popup and run Ediff for the current hunk."
+  (interactive)
+  (diff-hl-show-hunk-hide)
+  (diff-hl-ediff-current-hunk))
+
 ;;;###autoload
 (defun diff-hl-show-hunk-previous ()
   "Go to previous hunk/change and show it."

diff-hl.el

@@ -450,6 +450,17 @@ BUFFER defaults to the current buffer."
 (declare-function vc-git--rev-parse "vc-git")
 (declare-function vc-hg-command "vc-hg")
 (declare-function vc-bzr-command "vc-bzr")
+(declare-function vc-find-revision-no-save "vc")
+(declare-function ediff-buffers "ediff")
+(declare-function ediff-diff-at-point "ediff-util")
+(declare-function ediff-jump-to-difference "ediff-util")
+(defvar ediff-number-of-differences)
+
+(defun diff-hl--use-git-index-base-p (backend)
+  "Whether diff-hl should use the Git index as the reference base."
+  (and (eq backend 'Git)
+       (not diff-hl-reference-revision)
+       (not diff-hl-show-staged-changes)))
 
 (defun diff-hl-changes-buffer (file backend &optional new-rev bufname)
   (diff-hl-with-diff-switches
@@ -458,9 +469,7 @@ BUFFER defaults to the current buffer."
 (defun diff-hl-diff-against-reference (file backend buffer &optional new-rev)
   (cond
    ((and (not new-rev)
-         (not diff-hl-reference-revision)
-         (not diff-hl-show-staged-changes)
-         (eq backend 'Git))
+         (diff-hl--use-git-index-base-p backend))
     (apply #'vc-git-command buffer
            (if (diff-hl--use-async-p) 'async 1)
            (list file)
@@ -922,6 +931,54 @@ buffer will show the position corresponding to its current line."
                           (diff-hl-diff-skip-to line relname)
                           (setq vc-sentinel-movepoint (point))))))))
 
+(defun diff-hl--ediff-reference-buffer (file)
+  "Return the reference buffer for FILE used in Ediff."
+  (unless file
+    (user-error "No current file"))
+  (let ((backend (vc-backend file)))
+    (unless backend
+      (user-error "The buffer is not under version control"))
+    (let* ((reference diff-hl-reference-revision)
+           ;; Use the index snapshot only when diff-hl hides staged changes.
+           (use-index (and (diff-hl--use-git-index-base-p backend)
+                           (not diff-hl-highlight-reference-function)))
+           (buf
+            (if use-index
+                (let ((obj (diff-hl-git-index-object-name file)))
+                  (unless obj
+                    (user-error "No index entry for %s" file))
+                  (let ((filename (diff-hl-git-index-revision file obj)))
+                    (find-file-noselect filename)))
+              (let ((rev (or reference
+                             (assoc-default backend diff-hl-head-revision-alist)
+                             (diff-hl-working-revision file backend))))
+                (unless rev
+                  (user-error "No reference revision specified"))
+                (setq rev (diff-hl-resolved-revision backend rev))
+                (vc-find-revision-no-save file rev backend)))))
+      (with-current-buffer buf
+        (set-buffer-modified-p nil)
+        (read-only-mode 1))
+      buf)))
+
+;;;###autoload
+(defun diff-hl-ediff-current-hunk ()
+  "Run Ediff against current comparison base.  Jump to hunk at point."
+  (interactive)
+  (require 'ediff)
+  (let* ((pos (point))
+         (file (or buffer-file-name
+                   (and-let* ((base (buffer-base-buffer)))
+                     (buffer-file-name base))))
+         (refbuf (diff-hl--ediff-reference-buffer file))
+         (startup
+          (list
+           (lambda ()
+             (unless (zerop ediff-number-of-differences)
+               (ediff-jump-to-difference
+                (max 1 (ediff-diff-at-point 'B pos))))))))
+    (ediff-buffers refbuf (current-buffer) startup)))
+
 (defun diff-hl-diff-read-revisions (rev1-default)
   (let* ((file (diff-hl--buffer-file-name))
          (files (list file))
@@ -1541,9 +1598,7 @@ CONTEXT-LINES is the size of the unified diff context, defaults to 0."
            (temporary-file-directory diff-hl-temporary-directory)
            (enable-local-variables nil)
            (rev
-            (if (and (eq backend 'Git)
-                     (not diff-hl-reference-revision)
-                     (not diff-hl-show-staged-changes))
+            (if (diff-hl--use-git-index-base-p backend)
                 (diff-hl-git-index-revision
                  file
                  (diff-hl-git-index-object-name file))