]> code.delx.au - gnu-emacs/blobdiff - lisp/smerge-mode.el
Revision: miles@gnu.org--gnu-2004/emacs--unicode--0--patch-15
[gnu-emacs] / lisp / smerge-mode.el
index f561992fb24bb82c6cee7ead5e4e9d8aa539232e..35903dcf7491aba12bc86386fc3381114a947739 100644 (file)
@@ -1,10 +1,9 @@
 ;;; smerge-mode.el --- Minor mode to resolve diff3 conflicts
 
-;; Copyright (C) 1999, 2000, 2001  Free Software Foundation, Inc.
+;; Copyright (C) 1999, 2000, 01, 03, 2004  Free Software Foundation, Inc.
 
 ;; Author: Stefan Monnier <monnier@cs.yale.edu>
-;; Keywords: merge diff3 cvs conflict
-;; Revision: $Id: smerge-mode.el,v 1.13 2001/07/31 08:26:47 gerd Exp $
+;; Keywords: revision-control merge diff3 cvs conflict
 
 ;; This file is part of GNU Emacs.
 
@@ -38,7 +37,7 @@
 ;;      (goto-char (point-min))
 ;;      (when (re-search-forward "^<<<<<<< " nil t)
 ;;        (smerge-mode 1))))
-;;   (add-hook 'find-file-hooks 'sm-try-smerge t)
+;;   (add-hook 'find-file-hook 'sm-try-smerge t)
 
 ;;; Todo:
 
@@ -54,7 +53,7 @@
   :group 'tools
   :prefix "smerge-")
 
-(defcustom smerge-diff-buffer-name "*smerge-diff*"
+(defcustom smerge-diff-buffer-name "*vc-diff*"
   "Buffer name to use for displaying diffs."
   :group 'smerge
   :type '(choice
@@ -66,7 +65,7 @@
 (defcustom smerge-diff-switches
   (append '("-d" "-b")
          (if (listp diff-switches) diff-switches (list diff-switches)))
-  "*A list of strings specifying switches to be be passed to diff.
+  "*A list of strings specifying switches to be passed to diff.
 Used in `smerge-diff-base-mine' and related functions."
   :group 'smerge
   :type '(repeat string))
@@ -115,6 +114,7 @@ Used in `smerge-diff-base-mine' and related functions."
 (easy-mmode-defmap smerge-basic-map
   `(("n" . smerge-next)
     ("p" . smerge-prev)
+    ("r" . smerge-resolve)
     ("a" . smerge-keep-all)
     ("b" . smerge-keep-base)
     ("o" . smerge-keep-other)
@@ -136,26 +136,64 @@ Used in `smerge-diff-base-mine' and related functions."
   `((,smerge-command-prefix . ,smerge-basic-map))
   "Keymap for `smerge-mode'.")
 
+(defvar smerge-check-cache nil)
+(make-variable-buffer-local 'smerge-check-cache)
+(defun smerge-check (n)
+  (condition-case nil
+      (let ((state (cons (point) (buffer-modified-tick))))
+       (unless (equal (cdr smerge-check-cache) state)
+         (smerge-match-conflict)
+         (setq smerge-check-cache (cons (match-data) state)))
+       (nth (* 2 n) (car smerge-check-cache)))
+    (error nil)))
+
 (easy-menu-define smerge-mode-menu smerge-mode-map
   "Menu for `smerge-mode'."
   '("SMerge"
     ["Next" smerge-next :help "Go to next conflict"]
     ["Previous" smerge-prev :help "Go to previous conflict"]
-    ["Keep All" smerge-keep-all :help "Keep all three versions"]
-    ["Revert to Base" smerge-keep-base :help "Revert to base version"]
-    ["Keep Other" smerge-keep-other :help "Keep `other' version"]
-    ["Keep Yours" smerge-keep-mine :help "Keep your version"]
-    ["Keep Current" smerge-keep-current :help "Use current (at point) version"]
+    "--"
+    ["Keep All" smerge-keep-all :help "Keep all three versions"
+     :active (smerge-check 1)]
+    ["Keep Current" smerge-keep-current :help "Use current (at point) version"
+     :active (and (smerge-check 1) (> (smerge-get-current) 0))]
+    "--"
+    ["Revert to Base" smerge-keep-base :help "Revert to base version"
+     :active (smerge-check 2)]
+    ["Keep Other" smerge-keep-other :help "Keep `other' version"
+     :active (smerge-check 3)]
+    ["Keep Yours" smerge-keep-mine :help "Keep your version"
+     :active (smerge-check 1)]
     "--"
     ["Diff Base/Mine" smerge-diff-base-mine
-     :help "Diff `base' and `mine' for current conflict"]
+     :help "Diff `base' and `mine' for current conflict"
+     :active (smerge-check 2)]
     ["Diff Base/Other" smerge-diff-base-other
-     :help "Diff `base' and `other' for current conflict"]
+     :help "Diff `base' and `other' for current conflict"
+     :active (smerge-check 2)]
     ["Diff Mine/Other" smerge-diff-mine-other
-     :help "Diff `mine' and `other' for current conflict"]
+     :help "Diff `mine' and `other' for current conflict"
+     :active (smerge-check 1)]
     "--"
     ["Invoke Ediff" smerge-ediff
-     :help "Use Ediff to resolve the conflicts"]
+     :help "Use Ediff to resolve the conflicts"
+     :active (smerge-check 1)]
+    ["Auto Resolve" smerge-resolve
+     :help "Try auto-resolution heuristics"
+     :active (smerge-check 1)]
+    ["Combine" smerge-combine-with-next
+     :help "Combine current conflict with next"
+     :active (smerge-check 1)]
+    ))
+
+(easy-menu-define smerge-context-menu nil
+  "Context menu for mine area in `smerge-mode'."
+  '(nil
+    ["Keep Current" smerge-keep-current :help "Use current (at point) version"]
+    ["Kill Current" smerge-kill-current :help "Remove current (at point) version"]
+    ["Keep All" smerge-keep-all :help "Keep all three versions"]
+    "---"
+    ["More..." (popup-menu smerge-mode-menu) :help "Show full SMerge mode menu"]
     ))
 
 (defconst smerge-font-lock-keywords
@@ -183,9 +221,6 @@ Can be nil if the style is undecided, or else:
 ;; Compiler pacifiers
 (defvar font-lock-mode)
 (defvar font-lock-keywords)
-(eval-when-compile
-  (unless (fboundp 'font-lock-fontify-region)
-    (autoload 'font-lock-fontify-region "font-lock")))
 
 ;;;;
 ;;;; Actual code
@@ -205,17 +240,130 @@ Can be nil if the style is undecided, or else:
             (save-excursion (goto-char (point-min))
                             (not (re-search-forward smerge-begin-re nil t))))
     (smerge-mode -1)))
-    
+
 
 (defun smerge-keep-all ()
-  "Keep all three versions.
-Convenient for the kind of conflicts that can arise in ChangeLog files."
+  "Concatenate all versions."
   (interactive)
   (smerge-match-conflict)
-  (replace-match (concat (or (match-string 1) "")
-                        (or (match-string 2) "")
-                        (or (match-string 3) ""))
-                t t)
+  (let ((mb2 (or (match-beginning 2) (point-max)))
+       (me2 (or (match-end 2) (point-min))))
+    (delete-region (match-end 3) (match-end 0))
+    (delete-region (max me2 (match-end 1)) (match-beginning 3))
+    (if (and (match-end 2) (/= (match-end 1) (match-end 3)))
+       (delete-region (match-end 1) (match-beginning 2)))
+    (delete-region (match-beginning 0) (min (match-beginning 1) mb2))
+    (smerge-auto-leave)))
+
+(defun smerge-keep-n (n)
+  ;; We used to use replace-match, but that did not preserve markers so well.
+  (delete-region (match-end n) (match-end 0))
+  (delete-region (match-beginning 0) (match-beginning n)))
+
+(defun smerge-combine-with-next ()
+  "Combine the current conflict with the next one."
+  (interactive)
+  (smerge-match-conflict)
+  (let ((ends nil))
+    (dolist (i '(3 2 1 0))
+      (push (if (match-end i) (copy-marker (match-end i) t)) ends))
+    (setq ends (apply 'vector ends))
+    (goto-char (aref ends 0))
+    (if (not (re-search-forward smerge-begin-re nil t))
+       (error "No next conflict")
+      (smerge-match-conflict)
+      (let ((match-data (mapcar (lambda (m) (if m (copy-marker m)))
+                               (match-data))))
+       ;; First copy the in-between text in each alternative.
+       (dolist (i '(1 2 3))
+         (when (aref ends i)
+           (goto-char (aref ends i))
+           (insert-buffer-substring (current-buffer)
+                                    (aref ends 0) (car match-data))))
+       (delete-region (aref ends 0) (car match-data))
+       ;; Then move the second conflict's alternatives into the first.
+       (dolist (i '(1 2 3))
+         (set-match-data match-data)
+         (when (and (aref ends i) (match-end i))
+           (goto-char (aref ends i))
+           (insert-buffer-substring (current-buffer)
+                                    (match-beginning i) (match-end i))))
+       (delete-region (car match-data) (cadr match-data))
+       ;; Free the markers.
+       (dolist (m match-data) (if m (move-marker m nil)))
+       (mapc (lambda (m) (if m (move-marker m nil))) ends)))))
+
+(defvar smerge-resolve-function
+  (lambda () (error "Don't know how to resolve"))
+  "Mode-specific merge function.
+The function is called with no argument and with the match data set
+according to `smerge-match-conflict'.")
+
+(defvar smerge-text-properties
+  `(help-echo "merge conflict: mouse-3 shows a menu"
+    ;; mouse-face highlight
+    keymap (keymap (down-mouse-3 . smerge-popup-context-menu))))
+
+(defun smerge-remove-props (&optional beg end)
+  (remove-text-properties
+   (or beg (match-beginning 0))
+   (or end (match-end 0))
+   smerge-text-properties))
+
+(defun smerge-popup-context-menu (event)
+  "Pop up the Smerge mode context menu under mouse."
+  (interactive "e")
+  (if (and smerge-mode
+          (save-excursion (posn-set-point (event-end event)) (smerge-check 1)))
+      (progn
+       (posn-set-point (event-end event))
+       (smerge-match-conflict)
+       (let ((i (smerge-get-current))
+             o)
+         (if (<= i 0)
+             ;; Out of range
+             (popup-menu smerge-mode-menu)
+           ;; Install overlay.
+           (setq o (make-overlay (match-beginning i) (match-end i)))
+           (unwind-protect
+               (progn
+                 (overlay-put o 'face 'highlight)
+                 (sit-for 0)           ;Display the new highlighting.
+                 (popup-menu smerge-context-menu))
+             ;; Delete overlay.
+             (delete-overlay o)))))
+    ;; There's no conflict at point, the text-props are just obsolete.
+    (save-excursion
+      (let ((beg (re-search-backward smerge-end-re nil t))
+           (end (re-search-forward smerge-begin-re nil t)))
+       (smerge-remove-props (or beg (point-min)) (or end (point-max)))
+       (push event unread-command-events)))))
+
+(defun smerge-resolve ()
+  "Resolve the conflict at point intelligently.
+This relies on mode-specific knowledge and thus only works in
+some major modes.  Uses `smerge-resolve-function' to do the actual work."
+  (interactive)
+  (smerge-match-conflict)
+  (smerge-remove-props)
+  (cond
+   ;; Trivial diff3 -A non-conflicts.
+   ((and (eq (match-end 1) (match-end 3))
+        (eq (match-beginning 1) (match-beginning 3)))
+    ;; FIXME: Add "if [ diff -b MINE OTHER ]; then select OTHER; fi"
+    (smerge-keep-n 3))
+   ((and (match-end 2)
+        ;; FIXME: Add "diff -b BASE MINE | patch OTHER".
+        ;; FIXME: Add "diff -b BASE OTHER | patch MINE".
+        nil)
+    )
+   ((and (not (match-end 2))
+        ;; FIXME: Add "diff -b"-based refinement.
+        nil)
+    )
+   (t
+    ;; Mode-specific conflict resolution.
+    (funcall smerge-resolve-function)))
   (smerge-auto-leave))
 
 (defun smerge-keep-base ()
@@ -223,7 +371,8 @@ Convenient for the kind of conflicts that can arise in ChangeLog files."
   (interactive)
   (smerge-match-conflict)
   (smerge-ensure-match 2)
-  (replace-match (match-string 2) t t)
+  (smerge-remove-props)
+  (smerge-keep-n 2)
   (smerge-auto-leave))
 
 (defun smerge-keep-other ()
@@ -231,7 +380,8 @@ Convenient for the kind of conflicts that can arise in ChangeLog files."
   (interactive)
   (smerge-match-conflict)
   ;;(smerge-ensure-match 3)
-  (replace-match (match-string 3) t t)
+  (smerge-remove-props)
+  (smerge-keep-n 3)
   (smerge-auto-leave))
 
 (defun smerge-keep-mine ()
@@ -239,22 +389,45 @@ Convenient for the kind of conflicts that can arise in ChangeLog files."
   (interactive)
   (smerge-match-conflict)
   ;;(smerge-ensure-match 1)
-  (replace-match (match-string 1) t t)
+  (smerge-remove-props)
+  (smerge-keep-n 1)
   (smerge-auto-leave))
 
-(defun smerge-keep-current ()
-  "Use the current (under the cursor) version."
-  (interactive)
-  (smerge-match-conflict)
+(defun smerge-get-current ()
   (let ((i 3))
     (while (or (not (match-end i))
               (< (point) (match-beginning i))
               (>= (point) (match-end i)))
       (decf i))
+    i))
+
+(defun smerge-keep-current ()
+  "Use the current (under the cursor) version."
+  (interactive)
+  (smerge-match-conflict)
+  (let ((i (smerge-get-current)))
     (if (<= i 0) (error "Not inside a version")
-      (replace-match (match-string i) t t)
+      (smerge-remove-props)
+      (smerge-keep-n i)
       (smerge-auto-leave))))
 
+(defun smerge-kill-current ()
+  "Remove the current (under the cursor) version."
+  (interactive)
+  (smerge-match-conflict)
+  (let ((i (smerge-get-current)))
+    (if (<= i 0) (error "Not inside a version")
+      (smerge-remove-props)
+      (let ((left nil))
+       (dolist (n '(3 2 1))
+         (if (and (match-end n) (/= (match-end n) (match-end i)))
+             (push n left)))
+       (if (and (cdr left)
+                (/= (match-end (car left)) (match-end (cadr left))))
+           (ding)                      ;We don't know how to do that.
+         (smerge-keep-n (car left))
+         (smerge-auto-leave))))))
+
 (defun smerge-diff-base-mine ()
   "Diff 'base' and 'mine' version in current conflict region."
   (interactive)
@@ -287,11 +460,11 @@ An error is raised if not inside a conflict."
 
               (start (match-beginning 0))
               (mine-start (match-end 0))
-              (filename (match-string 1))
+              (filename (or (match-string 1) ""))
 
               (_ (re-search-forward smerge-end-re))
               (_ (assert (< orig-point (match-end 0))))
-              
+
               (other-end (match-beginning 0))
               (end (match-end 0))
 
@@ -304,6 +477,13 @@ An error is raised if not inside a conflict."
 
          ;; handle the various conflict styles
          (cond
+          ((save-excursion
+             (goto-char mine-start)
+             (re-search-forward smerge-begin-re end t))
+           ;; There's a nested conflict and we're after the the beginning
+           ;; of the outer one but before the beginning of the inner one.
+           (error "There is a nested conflict"))
+
           ((re-search-backward smerge-base-re start t)
            ;; a 3-parts conflict
            (set (make-local-variable 'smerge-conflict-style) 'diff3-A)
@@ -311,20 +491,28 @@ An error is raised if not inside a conflict."
            (setq mine-end (match-beginning 0))
            (setq base-start (match-end 0)))
 
-         ((string= filename (file-name-nondirectory
-                             (or buffer-file-name "")))
-          ;; a 2-parts conflict
-          (set (make-local-variable 'smerge-conflict-style) 'diff3-E))
-
-         ((and (not base-start)
-               (or (eq smerge-conflict-style 'diff3-A)
-                   (string-match "^[.0-9]+\\'" filename)))
-          ;; a same-diff conflict
-          (setq base-start mine-start)
-          (setq base-end   mine-end)
-          (setq mine-start other-start)
-          (setq mine-end   other-end)))
-              
+          ((string= filename (file-name-nondirectory
+                              (or buffer-file-name "")))
+           ;; a 2-parts conflict
+           (set (make-local-variable 'smerge-conflict-style) 'diff3-E))
+
+          ((and (not base-start)
+                (or (eq smerge-conflict-style 'diff3-A)
+                    (equal filename "ANCESTOR")
+                    (string-match "\\`[.0-9]+\\'" filename)))
+           ;; a same-diff conflict
+           (setq base-start mine-start)
+           (setq base-end   mine-end)
+           (setq mine-start other-start)
+           (setq mine-end   other-end)))
+
+         (let ((inhibit-read-only t)
+               (inhibit-modification-hooks t)
+               (m (buffer-modified-p)))
+           (unwind-protect
+               (add-text-properties start end smerge-text-properties)
+             (restore-buffer-modified-p m)))
+
          (store-match-data (list start end
                                  mine-start mine-end
                                  base-start base-end
@@ -332,7 +520,7 @@ An error is raised if not inside a conflict."
                                  (when base-start (1- base-start)) base-start
                                  (1- other-start) other-start))
          t)
-      (error "Point not in conflict region"))))
+      (search-failed (error "Point not in conflict region")))))
 
 (defun smerge-find-conflict (&optional limit)
   "Find and match a conflict region.  Intended as a font-lock MATCHER.
@@ -340,9 +528,11 @@ The submatches are the same as in `smerge-match-conflict'.
 Returns non-nil if a match is found between the point and LIMIT.
 The point is moved to the end of the conflict."
   (when (re-search-forward smerge-begin-re limit t)
-    (ignore-errors
-      (smerge-match-conflict)
-      (goto-char (match-end 0)))))
+    (condition-case err
+       (progn
+         (smerge-match-conflict)
+         (goto-char (match-end 0)))
+      (error (smerge-find-conflict limit)))))
 
 (defun smerge-diff (n1 n2)
   (smerge-match-conflict)
@@ -350,48 +540,58 @@ The point is moved to the end of the conflict."
   (smerge-ensure-match n2)
   (let ((name1 (aref smerge-match-names n1))
        (name2 (aref smerge-match-names n2))
+       ;; Read them before the match-data gets clobbered.
+       (beg1 (match-beginning n1))
+       (end1 (match-end n1))
+       (beg2 (match-beginning n2))
+       (end2 (match-end n2))
        (file1 (make-temp-file "smerge1"))
        (file2 (make-temp-file "smerge2"))
        (dir default-directory)
-       (file (file-relative-name buffer-file-name)))
-    (write-region (match-beginning n1) (match-end n1) file1)
-    (write-region (match-beginning n2) (match-end n2) file2)
+       (file (file-relative-name buffer-file-name))
+       (coding-system-for-read buffer-file-coding-system))
+    (write-region beg1 end1 file1 nil 'nomessage)
+    (write-region beg2 end2 file2 nil 'nomessage)
     (unwind-protect
        (with-current-buffer (get-buffer-create smerge-diff-buffer-name)
          (setq default-directory dir)
          (let ((inhibit-read-only t))
            (erase-buffer)
-           (apply 'call-process diff-command nil t nil
-                  (append smerge-diff-switches
-                          (list "-L" (concat name1 "/" file)
-                                "-L" (concat name2 "/" file)
-                                file1 file2))))
+           (let ((status
+                  (apply 'call-process diff-command nil t nil
+                         (append smerge-diff-switches
+                                 (list "-L" (concat name1 "/" file)
+                                       "-L" (concat name2 "/" file)
+                                       file1 file2)))))
+             (if (eq status 0) (insert "No differences found.\n"))))
          (goto-char (point-min))
          (diff-mode)
          (display-buffer (current-buffer) t))
       (delete-file file1)
       (delete-file file2))))
 
-(eval-when-compile
-  ;; compiler pacifiers
-  (defvar smerge-ediff-windows)
-  (defvar smerge-ediff-buf)
-  (defvar ediff-buffer-A)
-  (defvar ediff-buffer-B)
-  (defvar ediff-buffer-C)
-  (unless (fboundp 'ediff-cleanup-mess)
-    (autoload 'ediff-cleanup-mess "ediff-util")))
-
-(defun smerge-ediff ()
-  "Invoke ediff to resolve the conflicts."
+;; compiler pacifiers
+(defvar smerge-ediff-windows)
+(defvar smerge-ediff-buf)
+(defvar ediff-buffer-A)
+(defvar ediff-buffer-B)
+(defvar ediff-buffer-C)
+
+;;;###autoload
+(defun smerge-ediff (&optional name-mine name-other name-base)
+  "Invoke ediff to resolve the conflicts.
+NAME-MINE, NAME-OTHER, and NAME-BASE, if non-nil, are used for the
+buffer names."
   (interactive)
   (let* ((buf (current-buffer))
         (mode major-mode)
         ;;(ediff-default-variant 'default-B)
         (config (current-window-configuration))
         (filename (file-name-nondirectory buffer-file-name))
-        (mine (generate-new-buffer (concat "*" filename " MINE*")))
-        (other (generate-new-buffer (concat "*" filename " OTHER*")))
+        (mine (generate-new-buffer
+               (or name-mine (concat "*" filename " MINE*"))))
+        (other (generate-new-buffer
+                (or name-other (concat "*" filename " OTHER*"))))
         base)
     (with-current-buffer mine
       (buffer-disable-undo)
@@ -399,7 +599,7 @@ The point is moved to the end of the conflict."
       (goto-char (point-min))
       (while (smerge-find-conflict)
        (when (match-beginning 2) (setq base t))
-       (replace-match (match-string 1) t t))
+       (smerge-keep-n 1))
       (buffer-enable-undo)
       (set-buffer-modified-p nil)
       (funcall mode))
@@ -409,23 +609,26 @@ The point is moved to the end of the conflict."
       (insert-buffer-substring buf)
       (goto-char (point-min))
       (while (smerge-find-conflict)
-       (replace-match (match-string 3) t t))
+       (smerge-keep-n 3))
       (buffer-enable-undo)
       (set-buffer-modified-p nil)
       (funcall mode))
-    
+
     (when base
-      (setq base (generate-new-buffer (concat "*" filename " BASE*")))
+      (setq base (generate-new-buffer
+                 (or name-base (concat "*" filename " BASE*"))))
       (with-current-buffer base
        (buffer-disable-undo)
        (insert-buffer-substring buf)
        (goto-char (point-min))
        (while (smerge-find-conflict)
-         (replace-match (or (match-string 2) "") t t))
+         (if (match-end 2)
+             (smerge-keep-n 2)
+           (delete-region (match-beginning 0) (match-end 0))))
        (buffer-enable-undo)
        (set-buffer-modified-p nil)
        (funcall mode)))
-    
+
     ;; the rest of the code is inspired from vc.el
     ;; Fire up ediff.
     (set-buffer
@@ -434,7 +637,7 @@ The point is moved to the end of the conflict."
          ;; nil 'ediff-merge-revisions-with-ancestor buffer-file-name)
        (ediff-merge-buffers mine other)))
         ;; nil 'ediff-merge-revisions buffer-file-name)))
-    
+
     ;; Ediff is now set up, and we are in the control buffer.
     ;; Do a few further adjustments and take precautions for exit.
     (set (make-local-variable 'smerge-ediff-windows) config)
@@ -478,4 +681,6 @@ The point is moved to the end of the conflict."
 
 
 (provide 'smerge-mode)
+
+;; arch-tag: 605c8d1e-e43d-4943-a6f3-1bcc4333e690
 ;;; smerge-mode.el ends here