Initial support for bidirectional editing.
[bpt/emacs.git] / lisp / smerge-mode.el
index c80ae06..732f7d1 100644 (file)
@@ -1,17 +1,17 @@
 ;;; smerge-mode.el --- Minor mode to resolve diff3 conflicts
 
-;; Copyright (C) 1999, 2000, 2001, 2002, 2003,
-;;   2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
+;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
+;;   2007, 2008, 2009, 2010 Free Software Foundation, Inc.
 
 ;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
 ;; Keywords: tools revision-control merge diff3 cvs conflict
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ -19,9 +19,7 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
@@ -47,6 +45,7 @@
 ;;; Code:
 
 (eval-when-compile (require 'cl))
+(require 'diff-mode)                    ;For diff-auto-refine-mode.
 
 
 ;;; The real definition comes later.
@@ -79,11 +78,6 @@ Used in `smerge-diff-base-mine' and related functions."
   :group 'smerge
   :type 'boolean)
 
-(defcustom smerge-auto-refine t
-  "Automatically highlight changes in detail as the user visits conflicts."
-  :group 'smerge
-  :type 'boolean)
-
 (defface smerge-mine
   '((((min-colors 88) (background light))
      (:foreground "blue1"))
@@ -95,8 +89,7 @@ Used in `smerge-diff-base-mine' and related functions."
      (:foreground "cyan")))
   "Face for your code."
   :group 'smerge)
-;; backward-compatibility alias
-(put 'smerge-mine-face 'face-alias 'smerge-mine)
+(define-obsolete-face-alias 'smerge-mine-face 'smerge-mine "22.1")
 (defvar smerge-mine-face 'smerge-mine)
 
 (defface smerge-other
@@ -106,8 +99,7 @@ Used in `smerge-diff-base-mine' and related functions."
      (:foreground "lightgreen")))
   "Face for the other code."
   :group 'smerge)
-;; backward-compatibility alias
-(put 'smerge-other-face 'face-alias 'smerge-other)
+(define-obsolete-face-alias 'smerge-other-face 'smerge-other "22.1")
 (defvar smerge-other-face 'smerge-other)
 
 (defface smerge-base
@@ -119,8 +111,7 @@ Used in `smerge-diff-base-mine' and related functions."
      (:foreground "orange")))
   "Face for the base code."
   :group 'smerge)
-;; backward-compatibility alias
-(put 'smerge-base-face 'face-alias 'smerge-base)
+(define-obsolete-face-alias 'smerge-base-face 'smerge-base "22.1")
 (defvar smerge-base-face 'smerge-base)
 
 (defface smerge-markers
@@ -130,8 +121,7 @@ Used in `smerge-diff-base-mine' and related functions."
      (:background "grey30")))
   "Face for the conflict markers."
   :group 'smerge)
-;; backward-compatibility alias
-(put 'smerge-markers-face 'face-alias 'smerge-markers)
+(define-obsolete-face-alias 'smerge-markers-face 'smerge-markers "22.1")
 (defvar smerge-markers-face 'smerge-markers)
 
 (defface smerge-refined-change
@@ -160,7 +150,10 @@ Used in `smerge-diff-base-mine' and related functions."
 (defcustom smerge-command-prefix "\C-c^"
   "Prefix for `smerge-mode' commands."
   :group 'smerge
-  :type '(choice (string "\e") (string "\C-c^") (string "") string))
+  :type '(choice (const :tag "ESC"   "\e")
+                (const :tag "C-c ^" "\C-c^" )
+                (const :tag "none"  "")
+                string))
 
 (easy-mmode-defmap smerge-mode-map
   `((,smerge-command-prefix . ,smerge-basic-map))
@@ -258,7 +251,7 @@ Can be nil if the style is undecided, or else:
 
 ;; Define smerge-next and smerge-prev
 (easy-mmode-define-navigation smerge smerge-begin-re "conflict" nil nil
-  (if smerge-auto-refine
+  (if diff-auto-refine-mode
       (condition-case nil (smerge-refine) (error nil))))
 
 (defconst smerge-match-names ["conflict" "mine" "base" "other"])
@@ -374,9 +367,8 @@ according to `smerge-match-conflict'.")
   ;; during font-locking so inhibit-modification-hooks is non-nil, so we
   ;; can't just modify the buffer and expect font-lock to be triggered as in:
   ;; (put-text-property beg end 'smerge-force-highlighting nil)
-  (let ((modified (buffer-modified-p)))
-    (remove-text-properties beg end '(fontified nil))
-    (restore-buffer-modified-p modified)))
+  (with-silent-modifications
+    (remove-text-properties beg end '(fontified nil))))
 
 (defun smerge-popup-context-menu (event)
   "Pop up the Smerge mode context menu under mouse."
@@ -457,7 +449,7 @@ BUF contains a plain diff between match-1 and match-3."
             (with-current-buffer textbuf
               (forward-line (- startline line))
               (insert "<<<<<<< " name1 "\n" othertext
-                      (if name2 (concat "||||||| " name2))
+                      (if name2 (concat "||||||| " name2 "\n") "")
                       "=======\n")
               (forward-line lines)
               (insert ">>>>>>> " name3 "\n")
@@ -498,42 +490,48 @@ some major modes.  Uses `smerge-resolve-function' to do the actual work."
               (error nil))
             ;; Nothing to do: the resolution function has done it already.
             nil)
-          ;; "Mere whitespace" conflicts.
-          ((or (and (eq m1e m3e) (eq m1b m3b)) ;Non-conflict.
-               (progn
-                 (setq m (make-temp-file "smm"))
-                 (write-region m1b m1e m nil 'silent)
-                 (setq o (make-temp-file "smo"))
-                 (write-region m3b m3e o nil 'silent)
-                  ;; Same patch applied on both sides, with whitespace changes.
-                 (zerop (call-process diff-command nil nil nil "-b" m o)))
-               (when m2e
-                 (setq b (make-temp-file "smb"))
-                 (write-region m2b m2e b nil 'silent)
-                  ;; Only minor whitespace changes made locally.
-                 (zerop (call-process diff-command nil buf nil "-bc" b m))))
-           (set-match-data md)
-           (smerge-keep-n 3))
+           ;; Non-conflict.
+          ((and (eq m1e m3e) (eq m1b m3b))
+           (set-match-data md) (smerge-keep-n 3))
            ;; Refine a 2-way conflict using "diff -b".
            ;; In case of a 3-way conflict with an empty base
            ;; (i.e. 2 conflicting additions), we do the same, presuming
            ;; that the 2 additions should be somehow merged rather
            ;; than concatenated.
-          ((not (or (and m2b (not (eq m2b m2e)))
-                     (eq m1b m1e) (eq m3b m3e)
-                     (let ((lines (count-lines m3b m3e)))
-                       (call-process diff-command nil buf nil "-b" o m)
+          ((let ((lines (count-lines m3b m3e)))
+              (setq m (make-temp-file "smm"))
+              (write-region m1b m1e m nil 'silent)
+              (setq o (make-temp-file "smo"))
+              (write-region m3b m3e o nil 'silent)
+              (not (or (eq m1b m1e) (eq m3b m3e)
+                       (and (not (zerop (call-process diff-command
+                                                      nil buf nil "-b" o m)))
+                            ;; TODO: We don't know how to do the refinement
+                            ;; if there's a non-empty ancestor and m1 and m3
+                            ;; aren't just plain equal.
+                            m2b (not (eq m2b m2e)))
                        (with-current-buffer buf
                          (goto-char (point-min))
                          ;; Make sure there's some refinement.
                          (looking-at
                           (concat "1," (number-to-string lines) "c"))))))
             (smerge-apply-resolution-patch buf m0b m0e m3b m3e m2b))
+          ;; "Mere whitespace changes" conflicts.
+           ((when m2e
+              (setq b (make-temp-file "smb"))
+              (write-region m2b m2e b nil 'silent)
+              (with-current-buffer buf (erase-buffer))
+              ;; Only minor whitespace changes made locally.
+              ;; BEWARE: pass "-c" 'cause the output is reused in the next test.
+              (zerop (call-process diff-command nil buf nil "-bc" b m)))
+            (set-match-data md)
+           (smerge-keep-n 3))
           ;; Try "diff -b BASE MINE | patch OTHER".
           ((when (and (not safe) m2e b
                        ;; If the BASE is empty, this would just concatenate
                        ;; the two, which is rarely right.
                        (not (eq m2b m2e)))
+              ;; BEWARE: we're using here the patch of the previous test.
              (with-current-buffer buf
                (zerop (call-process-region
                        (point-min) (point-max) "patch" t nil nil
@@ -707,7 +705,7 @@ An error is raised if not inside a conflict."
           ((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
+           ;; There's a nested conflict and we're after the beginning
            ;; of the outer one but before the beginning of the inner one.
            ;; Of course, maybe this is not a nested conflict but in that
            ;; case it can only be something nastier that we don't know how
@@ -1016,9 +1014,10 @@ repeating the command will highlight other 2 parts."
         (n2 (if (eq part 3) 2 3)))
     (smerge-ensure-match n1)
     (smerge-ensure-match n2)
-    (put-text-property (match-beginning 0) (1+ (match-beginning 0))
-                       'smerge-refine-part
-                       (cons (buffer-chars-modified-tick) part))
+    (with-silent-modifications
+      (put-text-property (match-beginning 0) (1+ (match-beginning 0))
+                         'smerge-refine-part
+                         (cons (buffer-chars-modified-tick) part)))
     (smerge-refine-subst (match-beginning n1) (match-end n1)
                          (match-beginning n2)  (match-end n2)
                          '((smerge . refine)
@@ -1219,9 +1218,11 @@ with a \\[universal-argument] prefix, makes up a 3-way conflict."
 (defun smerge-start-session ()
   "Turn on `smerge-mode' and move point to first conflict marker.
 If no conflict maker is found, turn off `smerge-mode'."
+  (interactive)
   (smerge-mode 1)
   (condition-case nil
-      (smerge-next)
+      (unless (looking-at smerge-begin-re)
+        (smerge-next))
     (error (smerge-auto-leave))))
 
 (provide 'smerge-mode)