1 ;;; smerge-mode.el --- Minor mode to resolve diff3 conflicts
3 ;; Copyright (C) 1999-2011 Free Software Foundation, Inc.
5 ;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
6 ;; Keywords: vc, tools, revision control, merge, diff3, cvs, conflict
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; Provides a lightweight alternative to emerge/ediff.
26 ;; To use it, simply add to your .emacs the following lines:
28 ;; (autoload 'smerge-mode "smerge-mode" nil t)
30 ;; you can even have it turned on automatically with the following
31 ;; piece of code in your .emacs:
33 ;; (defun sm-try-smerge ()
35 ;; (goto-char (point-min))
36 ;; (when (re-search-forward "^<<<<<<< " nil t)
38 ;; (add-hook 'find-file-hook 'sm-try-smerge t)
42 ;; - if requested, ask the user whether he wants to call ediff right away
46 (eval-when-compile (require 'cl
))
47 (require 'diff-mode
) ;For diff-auto-refine-mode.
50 ;;; The real definition comes later.
54 "Minor mode to highlight and resolve diff3 conflicts."
58 (defcustom smerge-diff-buffer-name
"*vc-diff*"
59 "Buffer name to use for displaying diffs."
64 (const "*smerge-diff*")
67 (defcustom smerge-diff-switches
69 (if (listp diff-switches
) diff-switches
(list diff-switches
)))
70 "A list of strings specifying switches to be passed to diff.
71 Used in `smerge-diff-base-mine' and related functions."
73 :type
'(repeat string
))
75 (defcustom smerge-auto-leave t
76 "Non-nil means to leave `smerge-mode' when the last conflict is resolved."
81 '((((min-colors 88) (background light
))
82 (:foreground
"blue1"))
85 (((min-colors 88) (background dark
))
86 (:foreground
"cyan1"))
88 (:foreground
"cyan")))
91 (define-obsolete-face-alias 'smerge-mine-face
'smerge-mine
"22.1")
92 (defvar smerge-mine-face
'smerge-mine
)
95 '((((background light
))
96 (:foreground
"darkgreen"))
98 (:foreground
"lightgreen")))
99 "Face for the other code."
101 (define-obsolete-face-alias 'smerge-other-face
'smerge-other
"22.1")
102 (defvar smerge-other-face
'smerge-other
)
105 '((((min-colors 88) (background light
))
106 (:foreground
"red1"))
107 (((background light
))
110 (:foreground
"orange")))
111 "Face for the base code."
113 (define-obsolete-face-alias 'smerge-base-face
'smerge-base
"22.1")
114 (defvar smerge-base-face
'smerge-base
)
116 (defface smerge-markers
117 '((((background light
))
118 (:background
"grey85"))
120 (:background
"grey30")))
121 "Face for the conflict markers."
123 (define-obsolete-face-alias 'smerge-markers-face
'smerge-markers
"22.1")
124 (defvar smerge-markers-face
'smerge-markers
)
126 (defface smerge-refined-change
127 '((t :background
"yellow"))
128 "Face used for char-based changes shown by `smerge-refine'."
131 (easy-mmode-defmap smerge-basic-map
132 `(("n" . smerge-next
)
134 ("r" . smerge-resolve
)
135 ("a" . smerge-keep-all
)
136 ("b" . smerge-keep-base
)
137 ("o" . smerge-keep-other
)
138 ("m" . smerge-keep-mine
)
140 ("C" . smerge-combine-with-next
)
141 ("R" . smerge-refine
)
142 ("\C-m" . smerge-keep-current
)
143 ("=" .
,(make-sparse-keymap "Diff"))
144 ("=<" "base-mine" . smerge-diff-base-mine
)
145 ("=>" "base-other" . smerge-diff-base-other
)
146 ("==" "mine-other" . smerge-diff-mine-other
))
147 "The base keymap for `smerge-mode'.")
149 (defcustom smerge-command-prefix
"\C-c^"
150 "Prefix for `smerge-mode' commands."
152 :type
'(choice (const :tag
"ESC" "\e")
153 (const :tag
"C-c ^" "\C-c^" )
154 (const :tag
"none" "")
157 (easy-mmode-defmap smerge-mode-map
158 `((,smerge-command-prefix .
,smerge-basic-map
))
159 "Keymap for `smerge-mode'.")
161 (defvar smerge-check-cache nil
)
162 (make-variable-buffer-local 'smerge-check-cache
)
163 (defun smerge-check (n)
165 (let ((state (cons (point) (buffer-modified-tick))))
166 (unless (equal (cdr smerge-check-cache
) state
)
167 (smerge-match-conflict)
168 (setq smerge-check-cache
(cons (match-data) state
)))
169 (nth (* 2 n
) (car smerge-check-cache
)))
172 (easy-menu-define smerge-mode-menu smerge-mode-map
173 "Menu for `smerge-mode'."
175 ["Next" smerge-next
:help
"Go to next conflict"]
176 ["Previous" smerge-prev
:help
"Go to previous conflict"]
178 ["Keep All" smerge-keep-all
:help
"Keep all three versions"
179 :active
(smerge-check 1)]
180 ["Keep Current" smerge-keep-current
:help
"Use current (at point) version"
181 :active
(and (smerge-check 1) (> (smerge-get-current) 0))]
183 ["Revert to Base" smerge-keep-base
:help
"Revert to base version"
184 :active
(smerge-check 2)]
185 ["Keep Other" smerge-keep-other
:help
"Keep `other' version"
186 :active
(smerge-check 3)]
187 ["Keep Yours" smerge-keep-mine
:help
"Keep your version"
188 :active
(smerge-check 1)]
190 ["Diff Base/Mine" smerge-diff-base-mine
191 :help
"Diff `base' and `mine' for current conflict"
192 :active
(smerge-check 2)]
193 ["Diff Base/Other" smerge-diff-base-other
194 :help
"Diff `base' and `other' for current conflict"
195 :active
(smerge-check 2)]
196 ["Diff Mine/Other" smerge-diff-mine-other
197 :help
"Diff `mine' and `other' for current conflict"
198 :active
(smerge-check 1)]
200 ["Invoke Ediff" smerge-ediff
201 :help
"Use Ediff to resolve the conflicts"
202 :active
(smerge-check 1)]
203 ["Auto Resolve" smerge-resolve
204 :help
"Try auto-resolution heuristics"
205 :active
(smerge-check 1)]
206 ["Combine" smerge-combine-with-next
207 :help
"Combine current conflict with next"
208 :active
(smerge-check 1)]
211 (easy-menu-define smerge-context-menu nil
212 "Context menu for mine area in `smerge-mode'."
214 ["Keep Current" smerge-keep-current
:help
"Use current (at point) version"]
215 ["Kill Current" smerge-kill-current
:help
"Remove current (at point) version"]
216 ["Keep All" smerge-keep-all
:help
"Keep all three versions"]
218 ["More..." (popup-menu smerge-mode-menu
) :help
"Show full SMerge mode menu"]
221 (defconst smerge-font-lock-keywords
222 '((smerge-find-conflict
223 (1 smerge-mine-face prepend t
)
224 (2 smerge-base-face prepend t
)
225 (3 smerge-other-face prepend t
)
226 ;; FIXME: `keep' doesn't work right with syntactic fontification.
227 (0 smerge-markers-face keep
)
230 "Font lock patterns for `smerge-mode'.")
232 (defconst smerge-begin-re
"^<<<<<<< \\(.*\\)\n")
233 (defconst smerge-end-re
"^>>>>>>> .*\n")
234 (defconst smerge-base-re
"^||||||| .*\n")
235 (defconst smerge-other-re
"^=======\n")
237 (defvar smerge-conflict-style nil
238 "Keep track of which style of conflict is in use.
239 Can be nil if the style is undecided, or else:
243 ;; Compiler pacifiers
244 (defvar font-lock-mode
)
245 (defvar font-lock-keywords
)
251 ;; Define smerge-next and smerge-prev
252 (easy-mmode-define-navigation smerge smerge-begin-re
"conflict" nil nil
253 (if diff-auto-refine-mode
254 (condition-case nil
(smerge-refine) (error nil
))))
256 (defconst smerge-match-names
["conflict" "mine" "base" "other"])
258 (defun smerge-ensure-match (n)
259 (unless (match-end n
)
260 (error "No `%s'" (aref smerge-match-names n
))))
262 (defun smerge-auto-leave ()
263 (when (and smerge-auto-leave
264 (save-excursion (goto-char (point-min))
265 (not (re-search-forward smerge-begin-re nil t
))))
266 (when (and (listp buffer-undo-list
) smerge-mode
)
267 (push (list 'apply
'smerge-mode
1) buffer-undo-list
))
271 (defun smerge-keep-all ()
272 "Concatenate all versions."
274 (smerge-match-conflict)
275 (let ((mb2 (or (match-beginning 2) (point-max)))
276 (me2 (or (match-end 2) (point-min))))
277 (delete-region (match-end 3) (match-end 0))
278 (delete-region (max me2
(match-end 1)) (match-beginning 3))
279 (if (and (match-end 2) (/= (match-end 1) (match-end 3)))
280 (delete-region (match-end 1) (match-beginning 2)))
281 (delete-region (match-beginning 0) (min (match-beginning 1) mb2
))
282 (smerge-auto-leave)))
284 (defun smerge-keep-n (n)
285 (smerge-remove-props (match-beginning 0) (match-end 0))
286 ;; We used to use replace-match, but that did not preserve markers so well.
287 (delete-region (match-end n
) (match-end 0))
288 (delete-region (match-beginning 0) (match-beginning n
)))
290 (defun smerge-combine-with-next ()
291 "Combine the current conflict with the next one."
292 ;; `smerge-auto-combine' relies on the finish position (at the beginning
293 ;; of the closing marker).
295 (smerge-match-conflict)
297 (dolist (i '(3 2 1 0))
298 (push (if (match-end i
) (copy-marker (match-end i
) t
)) ends
))
299 (setq ends
(apply 'vector ends
))
300 (goto-char (aref ends
0))
301 (if (not (re-search-forward smerge-begin-re nil t
))
302 (error "No next conflict")
303 (smerge-match-conflict)
304 (let ((match-data (mapcar (lambda (m) (if m
(copy-marker m
)))
306 ;; First copy the in-between text in each alternative.
309 (goto-char (aref ends i
))
310 (insert-buffer-substring (current-buffer)
311 (aref ends
0) (car match-data
))))
312 (delete-region (aref ends
0) (car match-data
))
313 ;; Then move the second conflict's alternatives into the first.
315 (set-match-data match-data
)
316 (when (and (aref ends i
) (match-end i
))
317 (goto-char (aref ends i
))
318 (insert-buffer-substring (current-buffer)
319 (match-beginning i
) (match-end i
))))
320 (delete-region (car match-data
) (cadr match-data
))
322 (dolist (m match-data
) (if m
(move-marker m nil
)))
323 (mapc (lambda (m) (if m
(move-marker m nil
))) ends
)))))
325 (defvar smerge-auto-combine-max-separation
2
326 "Max number of lines between conflicts that should be combined.")
328 (defun smerge-auto-combine ()
329 "Automatically combine conflicts that are near each other."
332 (goto-char (point-min))
333 (while (smerge-find-conflict)
334 ;; 2 is 1 (default) + 1 (the begin markers).
335 (while (save-excursion
336 (smerge-find-conflict
337 (line-beginning-position
338 (+ 2 smerge-auto-combine-max-separation
))))
339 (forward-line -
1) ;Go back inside the conflict.
340 (smerge-combine-with-next)
341 (forward-line 1) ;Move past the end of the conflict.
344 (defvar smerge-resolve-function
345 (lambda () (error "Don't know how to resolve"))
346 "Mode-specific merge function.
347 The function is called with zero or one argument (non-nil if the resolution
348 function should only apply safe heuristics) and with the match data set
349 according to `smerge-match-conflict'.")
350 (add-to-list 'debug-ignored-errors
"Don't know how to resolve")
352 (defvar smerge-text-properties
353 `(help-echo "merge conflict: mouse-3 shows a menu"
354 ;; mouse-face highlight
355 keymap
(keymap (down-mouse-3 . smerge-popup-context-menu
))))
357 (defun smerge-remove-props (beg end
)
358 (remove-overlays beg end
'smerge
'refine
)
359 (remove-overlays beg end
'smerge
'conflict
)
360 ;; Now that we use overlays rather than text-properties, this function
361 ;; does not cause refontification any more. It can be seen very clearly
362 ;; in buffers where jit-lock-contextually is not t, in which case deleting
363 ;; the "<<<<<<< foobar" leading line leaves the rest of the conflict
364 ;; highlighted as if it were still a valid conflict. Note that in many
365 ;; important cases (such as the previous example) we're actually called
366 ;; during font-locking so inhibit-modification-hooks is non-nil, so we
367 ;; can't just modify the buffer and expect font-lock to be triggered as in:
368 ;; (put-text-property beg end 'smerge-force-highlighting nil)
369 (with-silent-modifications
370 (remove-text-properties beg end
'(fontified nil
))))
372 (defun smerge-popup-context-menu (event)
373 "Pop up the Smerge mode context menu under mouse."
376 (save-excursion (posn-set-point (event-end event
)) (smerge-check 1)))
378 (posn-set-point (event-end event
))
379 (smerge-match-conflict)
380 (let ((i (smerge-get-current))
384 (popup-menu smerge-mode-menu
)
386 (setq o
(make-overlay (match-beginning i
) (match-end i
)))
389 (overlay-put o
'face
'highlight
)
390 (sit-for 0) ;Display the new highlighting.
391 (popup-menu smerge-context-menu
))
393 (delete-overlay o
)))))
394 ;; There's no conflict at point, the text-props are just obsolete.
396 (let ((beg (re-search-backward smerge-end-re nil t
))
397 (end (re-search-forward smerge-begin-re nil t
)))
398 (smerge-remove-props (or beg
(point-min)) (or end
(point-max)))
399 (push event unread-command-events
)))))
401 (defun smerge-apply-resolution-patch (buf m0b m0e m3b m3e
&optional m2b
)
402 "Replace the conflict with a bunch of subconflicts.
403 BUF contains a plain diff between match-1 and match-3."
405 (textbuf (current-buffer))
406 (name1 (progn (goto-char m0b
)
407 (buffer-substring (+ (point) 8) (line-end-position))))
408 (name2 (when m2b
(goto-char m2b
) (forward-line -
1)
409 (buffer-substring (+ (point) 8) (line-end-position))))
410 (name3 (progn (goto-char m0e
) (forward-line -
1)
411 (buffer-substring (+ (point) 8) (line-end-position)))))
412 (smerge-remove-props m0b m0e
)
413 (delete-region m3e m0e
)
414 (delete-region m0b m3b
)
416 (setq m3e
(- m3e
(- m3b m0b
)))
418 (with-current-buffer buf
419 (goto-char (point-min))
421 (if (not (looking-at "\\([0-9]+\\)\\(?:,\\([0-9]+\\)\\)?\\([acd]\\)\\([0-9]+\\)\\(?:,\\([0-9]+\\)\\)?$"))
422 (error "Unexpected patch hunk header: %s"
423 (buffer-substring (point) (line-end-position)))
424 (let* ((op (char-after (match-beginning 3)))
425 (startline (+ (string-to-number (match-string 1))
426 ;; No clue why this is the way it is, but line
427 ;; numbers seem to be off-by-one for `a' ops.
428 (if (eq op ?a
) 1 0)))
429 (endline (if (eq op ?a
) startline
430 (1+ (if (match-end 2)
431 (string-to-number (match-string 2))
433 (lines (- endline startline
))
436 ((null (match-end 5)) 1)
437 (t (- (string-to-number (match-string 5))
438 (string-to-number (match-string 4)) -
1))))
440 (forward-line 1) ;Skip header.
441 (forward-line lines
) ;Skip deleted text.
442 (if (eq op ?c
) (forward-line 1)) ;Skip separator.
444 (if (null otherlines
) ""
446 (dotimes (i otherlines
) (delete-char 2) (forward-line 1))
447 (buffer-substring pos
(point)))))
448 (with-current-buffer textbuf
449 (forward-line (- startline line
))
450 (insert "<<<<<<< " name1
"\n" othertext
451 (if name2
(concat "||||||| " name2
"\n") "")
454 (insert ">>>>>>> " name3
"\n")
455 (setq line endline
))))))))
457 (defconst smerge-resolve--normalize-re
"[\n\t][ \t\n]*\\| [ \t\n]+")
459 (defun smerge-resolve--extract-comment (beg end
)
460 "Extract the text within the comments that span BEG..END."
465 (while (and (< (point) end
)
466 (setq combeg
(comment-search-forward end t
)))
471 (comment-enter-backward)
473 (push (buffer-substring-no-properties beg
(point)) comments
))))
476 (apply #'insert
(nreverse comments
))
477 (goto-char (point-min))
478 (while (re-search-forward smerge-resolve--normalize-re
483 (defun smerge-resolve--normalize (beg end
)
484 (replace-regexp-in-string
485 smerge-resolve--normalize-re
" "
486 (concat " " (buffer-substring-no-properties beg end
) " ")))
488 (defun smerge-resolve (&optional safe
)
489 "Resolve the conflict at point intelligently.
490 This relies on mode-specific knowledge and thus only works in some
491 major modes. Uses `smerge-resolve-function' to do the actual work."
493 (smerge-match-conflict)
494 (smerge-remove-props (match-beginning 0) (match-end 0))
495 (let ((md (match-data))
496 (m0b (match-beginning 0))
497 (m1b (match-beginning 1))
498 (m2b (match-beginning 2))
499 (m3b (match-beginning 3))
504 (buf (generate-new-buffer " *smerge*"))
510 ;; Trivial diff3 -A non-conflicts.
511 ((and (eq (match-end 1) (match-end 3))
512 (eq (match-beginning 1) (match-beginning 3)))
514 ;; Mode-specific conflict resolution.
518 (funcall smerge-resolve-function safe
)
519 (funcall smerge-resolve-function
))
522 ;; Nothing to do: the resolution function has done it already.
525 ((and (eq m1e m3e
) (eq m1b m3b
))
526 (set-match-data md
) (smerge-keep-n 3))
527 ;; Refine a 2-way conflict using "diff -b".
528 ;; In case of a 3-way conflict with an empty base
529 ;; (i.e. 2 conflicting additions), we do the same, presuming
530 ;; that the 2 additions should be somehow merged rather
531 ;; than concatenated.
532 ((let ((lines (count-lines m3b m3e
)))
533 (setq m
(make-temp-file "smm"))
534 (write-region m1b m1e m nil
'silent
)
535 (setq o
(make-temp-file "smo"))
536 (write-region m3b m3e o nil
'silent
)
537 (not (or (eq m1b m1e
) (eq m3b m3e
)
538 (and (not (zerop (call-process diff-command
539 nil buf nil
"-b" o m
)))
540 ;; TODO: We don't know how to do the refinement
541 ;; if there's a non-empty ancestor and m1 and m3
542 ;; aren't just plain equal.
543 m2b
(not (eq m2b m2e
)))
544 (with-current-buffer buf
545 (goto-char (point-min))
546 ;; Make sure there's some refinement.
548 (concat "1," (number-to-string lines
) "c"))))))
549 (smerge-apply-resolution-patch buf m0b m0e m3b m3e m2b
))
550 ;; "Mere whitespace changes" conflicts.
552 (setq b
(make-temp-file "smb"))
553 (write-region m2b m2e b nil
'silent
)
554 (with-current-buffer buf
(erase-buffer))
555 ;; Only minor whitespace changes made locally.
556 ;; BEWARE: pass "-c" 'cause the output is reused in the next test.
557 (zerop (call-process diff-command nil buf nil
"-bc" b m
)))
560 ;; Try "diff -b BASE MINE | patch OTHER".
561 ((when (and (not safe
) m2e b
562 ;; If the BASE is empty, this would just concatenate
563 ;; the two, which is rarely right.
565 ;; BEWARE: we're using here the patch of the previous test.
566 (with-current-buffer buf
567 (zerop (call-process-region
568 (point-min) (point-max) "patch" t nil nil
569 "-r" "/dev/null" "--no-backup-if-mismatch"
572 (narrow-to-region m0b m0e
)
573 (smerge-remove-props m0b m0e
)
574 (insert-file-contents o nil nil nil t
)))
575 ;; Try "diff -b BASE OTHER | patch MINE".
576 ((when (and (not safe
) m2e b
577 ;; If the BASE is empty, this would just concatenate
578 ;; the two, which is rarely right.
580 (write-region m3b m3e o nil
'silent
)
581 (call-process diff-command nil buf nil
"-bc" b o
)
582 (with-current-buffer buf
583 (zerop (call-process-region
584 (point-min) (point-max) "patch" t nil nil
585 "-r" "/dev/null" "--no-backup-if-mismatch"
588 (narrow-to-region m0b m0e
)
589 (smerge-remove-props m0b m0e
)
590 (insert-file-contents m nil nil nil t
)))
591 ;; If the conflict is only made of comments, and one of the two
592 ;; changes is only rearranging spaces (e.g. reflowing text) while
593 ;; the other is a real change, drop the space-rearrangement.
595 (comment-only-p m1b m1e
)
596 (comment-only-p m2b m2e
)
597 (comment-only-p m3b m3e
)
598 (let ((t1 (smerge-resolve--extract-comment m1b m1e
))
599 (t2 (smerge-resolve--extract-comment m2b m2e
))
600 (t3 (smerge-resolve--extract-comment m3b m3e
)))
602 ((and (equal t1 t2
) (not (equal t2 t3
)))
604 ((and (not (equal t1 t2
)) (equal t2 t3
))
607 (smerge-keep-n choice
))
608 ;; Idem, when the conflict is contained within a single comment.
611 (nth 4 (syntax-ppss m0b
))
612 ;; If there's a conflict earlier in the file,
613 ;; syntax-ppss is not reliable.
614 (not (re-search-backward smerge-begin-re nil t
))
615 (progn (goto-char (nth 8 (syntax-ppss m0b
)))
618 (let ((t1 (smerge-resolve--normalize m1b m1e
))
619 (t2 (smerge-resolve--normalize m2b m2e
))
620 (t3 (smerge-resolve--normalize m3b m3e
)))
622 ((and (equal t1 t2
) (not (equal t2 t3
)))
624 ((and (not (equal t1 t2
)) (equal t2 t3
))
627 (smerge-keep-n choice
))
629 (error "Don't know how to resolve"))))
630 (if (buffer-name buf
) (kill-buffer buf
))
631 (if m
(delete-file m
))
632 (if b
(delete-file b
))
633 (if o
(delete-file o
))))
636 (defun smerge-resolve-all ()
637 "Perform automatic resolution on all conflicts."
640 (goto-char (point-min))
641 (while (re-search-forward smerge-begin-re nil t
)
644 (smerge-match-conflict)
645 (smerge-resolve 'safe
))
648 (defun smerge-batch-resolve ()
649 ;; command-line-args-left is what is left of the command line.
650 (if (not noninteractive
)
651 (error "`smerge-batch-resolve' is to be used only with -batch"))
652 (while command-line-args-left
653 (let ((file (pop command-line-args-left
)))
654 (if (string-match "\\.rej\\'" file
)
655 ;; .rej files should never contain diff3 markers, on the other hand,
656 ;; in Arch, .rej files are sometimes used to indicate that the
657 ;; main file has diff3 markers. So you can pass **/*.rej and
659 (setq file
(substring file
0 (match-beginning 0))))
660 (message "Resolving conflicts in %s..." file
)
661 (when (file-readable-p file
)
662 (with-current-buffer (find-file-noselect file
)
665 (kill-buffer (current-buffer)))))))
667 (defun smerge-keep-base ()
668 "Revert to the base version."
670 (smerge-match-conflict)
671 (smerge-ensure-match 2)
675 (defun smerge-keep-other ()
676 "Use \"other\" version."
678 (smerge-match-conflict)
679 ;;(smerge-ensure-match 3)
683 (defun smerge-keep-mine ()
686 (smerge-match-conflict)
687 ;;(smerge-ensure-match 1)
691 (defun smerge-get-current ()
693 (while (or (not (match-end i
))
694 (< (point) (match-beginning i
))
695 (>= (point) (match-end i
)))
699 (defun smerge-keep-current ()
700 "Use the current (under the cursor) version."
702 (smerge-match-conflict)
703 (let ((i (smerge-get-current)))
704 (if (<= i
0) (error "Not inside a version")
706 (smerge-auto-leave))))
708 (defun smerge-kill-current ()
709 "Remove the current (under the cursor) version."
711 (smerge-match-conflict)
712 (let ((i (smerge-get-current)))
713 (if (<= i
0) (error "Not inside a version")
716 (if (and (match-end n
) (/= (match-end n
) (match-end i
)))
719 (/= (match-end (car left
)) (match-end (cadr left
))))
720 (ding) ;We don't know how to do that.
721 (smerge-keep-n (car left
))
722 (smerge-auto-leave))))))
724 (defun smerge-diff-base-mine ()
725 "Diff 'base' and 'mine' version in current conflict region."
729 (defun smerge-diff-base-other ()
730 "Diff 'base' and 'other' version in current conflict region."
734 (defun smerge-diff-mine-other ()
735 "Diff 'mine' and 'other' version in current conflict region."
739 (defun smerge-match-conflict ()
740 "Get info about the conflict. Puts the info in the `match-data'.
741 The submatches contain:
742 0: the whole conflict.
746 An error is raised if not inside a conflict."
749 (let* ((orig-point (point))
752 (_ (re-search-backward smerge-begin-re
))
754 (start (match-beginning 0))
755 (mine-start (match-end 0))
756 (filename (or (match-string 1) ""))
758 (_ (re-search-forward smerge-end-re
))
759 (_ (assert (< orig-point
(match-end 0))))
761 (other-end (match-beginning 0))
764 (_ (re-search-backward smerge-other-re start
))
766 (mine-end (match-beginning 0))
767 (other-start (match-end 0))
771 ;; handle the various conflict styles
774 (goto-char mine-start
)
775 (re-search-forward smerge-begin-re end t
))
776 ;; There's a nested conflict and we're after the beginning
777 ;; of the outer one but before the beginning of the inner one.
778 ;; Of course, maybe this is not a nested conflict but in that
779 ;; case it can only be something nastier that we don't know how
780 ;; to handle, so may as well arbitrarily decide to treat it as
781 ;; a nested conflict. --Stef
782 (error "There is a nested conflict"))
784 ((re-search-backward smerge-base-re start t
)
785 ;; a 3-parts conflict
786 (set (make-local-variable 'smerge-conflict-style
) 'diff3-A
)
787 (setq base-end mine-end
)
788 (setq mine-end
(match-beginning 0))
789 (setq base-start
(match-end 0)))
791 ((string= filename
(file-name-nondirectory
792 (or buffer-file-name
"")))
793 ;; a 2-parts conflict
794 (set (make-local-variable 'smerge-conflict-style
) 'diff3-E
))
796 ((and (not base-start
)
797 (or (eq smerge-conflict-style
'diff3-A
)
798 (equal filename
"ANCESTOR")
799 (string-match "\\`[.0-9]+\\'" filename
)))
800 ;; a same-diff conflict
801 (setq base-start mine-start
)
802 (setq base-end mine-end
)
803 (setq mine-start other-start
)
804 (setq mine-end other-end
)))
806 (store-match-data (list start end
809 other-start other-end
810 (when base-start
(1- base-start
)) base-start
811 (1- other-start
) other-start
))
813 (search-failed (error "Point not in conflict region")))))
815 (add-to-list 'debug-ignored-errors
"Point not in conflict region")
817 (defun smerge-conflict-overlay (pos)
818 "Return the conflict overlay at POS if any."
819 (let ((ols (overlays-at pos
))
822 (if (and (eq (overlay-get ol
'smerge
) 'conflict
)
823 (> (overlay-end ol
) pos
))
827 (defun smerge-find-conflict (&optional limit
)
828 "Find and match a conflict region. Intended as a font-lock MATCHER.
829 The submatches are the same as in `smerge-match-conflict'.
830 Returns non-nil if a match is found between point and LIMIT.
831 Point is moved to the end of the conflict."
835 ;; First check to see if point is already inside a conflict, using
836 ;; the conflict overlays.
837 (while (and (not found
) (setq conflict
(smerge-conflict-overlay pos
)))
838 ;; Check the overlay's validity and kill it if it's out of date.
841 (goto-char (overlay-start conflict
))
842 (smerge-match-conflict)
843 (goto-char (match-end 0))
845 (error "Matching backward!")
847 (error (smerge-remove-props
848 (overlay-start conflict
) (overlay-end conflict
))
850 ;; If we're not already inside a conflict, look for the next conflict
851 ;; and add/update its overlay.
852 (while (and (not found
) (re-search-forward smerge-begin-re limit t
))
855 (smerge-match-conflict)
856 (goto-char (match-end 0))
857 (let ((conflict (smerge-conflict-overlay (1- (point)))))
859 ;; Update its location, just in case it got messed up.
860 (move-overlay conflict
(match-beginning 0) (match-end 0))
861 (setq conflict
(make-overlay (match-beginning 0) (match-end 0)
862 nil
'front-advance nil
))
863 (overlay-put conflict
'evaporate t
)
864 (overlay-put conflict
'smerge
'conflict
)
865 (let ((props smerge-text-properties
))
867 (overlay-put conflict
(pop props
) (pop props
))))))
872 ;;; Refined change highlighting
874 (defvar smerge-refine-forward-function
'smerge-refine-forward
875 "Function used to determine an \"atomic\" element.
876 You can set it to `forward-char' to get char-level granularity.
877 Its behavior has mainly two restrictions:
878 - if this function encounters a newline, it's important that it stops right
880 This only matters if `smerge-refine-ignore-whitespace' is nil.
881 - it needs to be unaffected by changes performed by the `preproc' argument
882 to `smerge-refine-subst'.
883 This only matters if `smerge-refine-weight-hack' is nil.")
885 (defvar smerge-refine-ignore-whitespace t
886 "If non-nil, indicate that `smerge-refine' should try to ignore change in whitespace.")
888 (defvar smerge-refine-weight-hack t
889 "If non-nil, pass to diff as many lines as there are chars in the region.
890 I.e. each atomic element (e.g. word) will be copied as many times (on different
891 lines) as it has chars. This has two advantages:
892 - if `diff' tries to minimize the number *lines* (rather than chars)
893 added/removed, this adjust the weights so that adding/removing long
894 symbols is considered correspondingly more costly.
895 - `smerge-refine-forward-function' only needs to be called when chopping up
896 the regions, and `forward-char' can be used afterwards.
897 It has the following disadvantages:
898 - cannot use `diff -w' because the weighting causes added spaces in a line
899 to be represented as added copies of some line, so `diff -w' can't do the
900 right thing any more.
901 - may in degenerate cases take a 1KB input region and turn it into a 1MB
902 file to pass to diff.")
904 (defun smerge-refine-forward (n)
905 (let ((case-fold-search nil
)
906 (re "[[:upper:]]?[[:lower:]]+\\|[[:upper:]]+\\|[[:digit:]]+\\|.\\|\n"))
907 (when (and smerge-refine-ignore-whitespace
908 ;; smerge-refine-weight-hack causes additional spaces to
909 ;; appear as additional lines as well, so even if diff ignore
910 ;; whitespace changes, it'll report added/removed lines :-(
911 (not smerge-refine-weight-hack
))
912 (setq re
(concat "[ \t]*\\(?:" re
"\\)")))
914 (unless (looking-at re
) (error "Smerge refine internal error"))
915 (goto-char (match-end 0)))))
917 (defun smerge-refine-chopup-region (beg end file
&optional preproc
)
918 "Chopup the region into small elements, one per line.
919 Save the result into FILE.
920 If non-nil, PREPROC is called with no argument in a buffer that contains
921 a copy of the text, just before chopping it up. It can be used to replace
922 chars to try and eliminate some spurious differences."
923 ;; We used to chop up char-by-char rather than word-by-word like ediff
924 ;; does. It had the benefit of simplicity and very fine results, but it
925 ;; often suffered from problem that diff would find correlations where
926 ;; there aren't any, so the resulting "change" didn't make much sense.
927 ;; You can still get this behavior by setting
928 ;; `smerge-refine-forward-function' to `forward-char'.
929 (let ((buf (current-buffer)))
931 (insert-buffer-substring buf beg end
)
932 (when preproc
(goto-char (point-min)) (funcall preproc
))
933 (when smerge-refine-ignore-whitespace
934 ;; It doesn't make much of a difference for diff-fine-highlight
935 ;; because we still have the _/+/</>/! prefix anyway. Can still be
936 ;; useful in other circumstances.
937 (subst-char-in-region (point-min) (point-max) ?
\n ?\s
))
938 (goto-char (point-min))
940 (funcall smerge-refine-forward-function
1)
941 (let ((s (if (prog2 (forward-char -
1) (bolp) (forward-char 1))
943 (buffer-substring (line-beginning-position) (point)))))
944 ;; We add \n after each char except after \n, so we get
945 ;; one line per text char, where each line contains
946 ;; just one char, except for \n chars which are
947 ;; represented by the empty line.
948 (unless (eq (char-before) ?
\n) (insert ?
\n))
950 (if smerge-refine-weight-hack
951 (dotimes (i (1- (length s
))) (insert s
"\n")))))
952 (unless (bolp) (error "Smerge refine internal error"))
953 (let ((coding-system-for-write 'emacs-mule
))
954 (write-region (point-min) (point-max) file nil
'nomessage
)))))
956 (defun smerge-refine-highlight-change (buf beg match-num1 match-num2 props
)
957 (with-current-buffer buf
959 (let* ((startline (- (string-to-number match-num1
) 1))
960 (beg (progn (funcall (if smerge-refine-weight-hack
962 smerge-refine-forward-function
)
965 (end (progn (funcall (if smerge-refine-weight-hack
967 smerge-refine-forward-function
)
969 (- (string-to-number match-num2
)
973 (when smerge-refine-ignore-whitespace
974 (skip-chars-backward " \t\n" beg
) (setq end
(point))
976 (skip-chars-forward " \t\n" end
) (setq beg
(point)))
978 (let ((ol (make-overlay
980 ;; Make them tend to shrink rather than spread when editing.
981 'front-advance nil
)))
982 (overlay-put ol
'evaporate t
)
983 (dolist (x props
) (overlay-put ol
(car x
) (cdr x
)))
986 (defun smerge-refine-subst (beg1 end1 beg2 end2 props
&optional preproc
)
987 "Show fine differences in the two regions BEG1..END1 and BEG2..END2.
988 PROPS is an alist of properties to put (via overlays) on the changes.
989 If non-nil, PREPROC is called with no argument in a buffer that contains
990 a copy of a region, just before preparing it to for `diff'. It can be
991 used to replace chars to try and eliminate some spurious differences."
992 (let* ((buf (current-buffer))
994 (file1 (make-temp-file "diff1"))
995 (file2 (make-temp-file "diff2")))
996 ;; Chop up regions into smaller elements and save into files.
997 (smerge-refine-chopup-region beg1 end1 file1 preproc
)
998 (smerge-refine-chopup-region beg2 end2 file2 preproc
)
1000 ;; Call diff on those files.
1003 (let ((coding-system-for-read 'emacs-mule
))
1004 (call-process diff-command nil t nil
1005 (if (and smerge-refine-ignore-whitespace
1006 (not smerge-refine-weight-hack
))
1007 ;; Pass -a so diff treats it as a text file even
1008 ;; if it contains \0 and such.
1009 ;; Pass -d so as to get the smallest change, but
1010 ;; also and more importantly because otherwise it
1011 ;; may happen that diff doesn't behave like
1012 ;; smerge-refine-weight-hack expects it to.
1013 ;; See http://thread.gmane.org/gmane.emacs.devel/82685.
1016 ;; Process diff's output.
1017 (goto-char (point-min))
1021 (if (not (looking-at "\\([0-9]+\\)\\(?:,\\([0-9]+\\)\\)?\\([acd]\\)\\([0-9]+\\)\\(?:,\\([0-9]+\\)\\)?$"))
1022 (error "Unexpected patch hunk header: %s"
1023 (buffer-substring (point) (line-end-position))))
1024 (let ((op (char-after (match-beginning 3)))
1025 (m1 (match-string 1))
1026 (m2 (match-string 2))
1027 (m4 (match-string 4))
1028 (m5 (match-string 5)))
1029 (when (memq op
'(?d ?c
))
1031 (smerge-refine-highlight-change buf beg1 m1 m2 props
)))
1032 (when (memq op
'(?a ?c
))
1034 (smerge-refine-highlight-change buf beg2 m4 m5 props
))))
1035 (forward-line 1) ;Skip hunk header.
1036 (and (re-search-forward "^[0-9]" nil
'move
) ;Skip hunk body.
1037 (goto-char (match-beginning 0))))
1038 ;; (assert (or (null last1) (< (overlay-start last1) end1)))
1039 ;; (assert (or (null last2) (< (overlay-start last2) end2)))
1040 (if smerge-refine-weight-hack
1042 ;; (assert (or (null last1) (<= (overlay-end last1) end1)))
1043 ;; (assert (or (null last2) (<= (overlay-end last2) end2)))
1045 ;; smerge-refine-forward-function when calling in chopup may
1046 ;; have stopped because it bumped into EOB whereas in
1047 ;; smerge-refine-weight-hack it may go a bit further.
1048 (if (and last1
(> (overlay-end last1
) end1
))
1049 (move-overlay last1
(overlay-start last1
) end1
))
1050 (if (and last2
(> (overlay-end last2
) end2
))
1051 (move-overlay last2
(overlay-start last2
) end2
))
1055 (delete-file file2
))))
1057 (defun smerge-refine (&optional part
)
1058 "Highlight the words of the conflict that are different.
1059 For 3-way conflicts, highlights only two of the three parts.
1060 A numeric argument PART can be used to specify which two parts;
1061 repeating the command will highlight other two parts."
1063 (if (integerp current-prefix-arg
) (list current-prefix-arg
)
1064 (smerge-match-conflict)
1065 (let* ((prop (get-text-property (match-beginning 0) 'smerge-refine-part
))
1066 (part (if (and (consp prop
)
1067 (eq (buffer-chars-modified-tick) (car prop
)))
1069 ;; If already highlighted, cycle.
1070 (list (if (integerp part
) (1+ (mod part
3)))))))
1072 (if (and (integerp part
) (or (< part
1) (> part
3)))
1073 (error "No conflict part nb %s" part
))
1074 (smerge-match-conflict)
1075 (remove-overlays (match-beginning 0) (match-end 0) 'smerge
'refine
)
1076 ;; Ignore `part' if not applicable, and default it if not provided.
1077 (setq part
(cond ((null (match-end 2)) 2)
1078 ((eq (match-end 1) (match-end 3)) 1)
1079 ((integerp part
) part
)
1080 ;; If one of the parts is empty, any refinement using
1081 ;; it will be trivial and uninteresting.
1082 ((eq (match-end 1) (match-beginning 1)) 1)
1083 ((eq (match-end 3) (match-beginning 3)) 3)
1085 (let ((n1 (if (eq part
1) 2 1))
1086 (n2 (if (eq part
3) 2 3)))
1087 (smerge-ensure-match n1
)
1088 (smerge-ensure-match n2
)
1089 (with-silent-modifications
1090 (put-text-property (match-beginning 0) (1+ (match-beginning 0))
1092 (cons (buffer-chars-modified-tick) part
)))
1093 (smerge-refine-subst (match-beginning n1
) (match-end n1
)
1094 (match-beginning n2
) (match-end n2
)
1096 (face . smerge-refined-change
)))))
1098 (defun smerge-diff (n1 n2
)
1099 (smerge-match-conflict)
1100 (smerge-ensure-match n1
)
1101 (smerge-ensure-match n2
)
1102 (let ((name1 (aref smerge-match-names n1
))
1103 (name2 (aref smerge-match-names n2
))
1104 ;; Read them before the match-data gets clobbered.
1105 (beg1 (match-beginning n1
))
1106 (end1 (match-end n1
))
1107 (beg2 (match-beginning n2
))
1108 (end2 (match-end n2
))
1109 (file1 (make-temp-file "smerge1"))
1110 (file2 (make-temp-file "smerge2"))
1111 (dir default-directory
)
1112 (file (if buffer-file-name
(file-relative-name buffer-file-name
)))
1113 ;; We would want to use `emacs-mule-unix' for read&write, but we
1114 ;; bump into problems with the coding-system used by diff to write
1115 ;; the file names and the time stamps in the header.
1116 ;; `buffer-file-coding-system' is not always correct either, but if
1117 ;; the OS/user uses only one coding-system, then it works.
1118 (coding-system-for-read buffer-file-coding-system
))
1119 (write-region beg1 end1 file1 nil
'nomessage
)
1120 (write-region beg2 end2 file2 nil
'nomessage
)
1122 (with-current-buffer (get-buffer-create smerge-diff-buffer-name
)
1123 (setq default-directory dir
)
1124 (let ((inhibit-read-only t
))
1127 (apply 'call-process diff-command nil t nil
1128 (append smerge-diff-switches
1129 (list "-L" (concat name1
"/" file
)
1130 "-L" (concat name2
"/" file
)
1132 (if (eq status
0) (insert "No differences found.\n"))))
1133 (goto-char (point-min))
1135 (display-buffer (current-buffer) t
))
1137 (delete-file file2
))))
1139 ;; compiler pacifiers
1140 (defvar smerge-ediff-windows
)
1141 (defvar smerge-ediff-buf
)
1142 (defvar ediff-buffer-A
)
1143 (defvar ediff-buffer-B
)
1144 (defvar ediff-buffer-C
)
1145 (defvar ediff-ancestor-buffer
)
1146 (defvar ediff-quit-hook
)
1147 (declare-function ediff-cleanup-mess
"ediff-util" nil
)
1150 (defun smerge-ediff (&optional name-mine name-other name-base
)
1151 "Invoke ediff to resolve the conflicts.
1152 NAME-MINE, NAME-OTHER, and NAME-BASE, if non-nil, are used for the
1155 (let* ((buf (current-buffer))
1157 ;;(ediff-default-variant 'default-B)
1158 (config (current-window-configuration))
1159 (filename (file-name-nondirectory buffer-file-name
))
1160 (mine (generate-new-buffer
1161 (or name-mine
(concat "*" filename
" MINE*"))))
1162 (other (generate-new-buffer
1163 (or name-other
(concat "*" filename
" OTHER*"))))
1165 (with-current-buffer mine
1166 (buffer-disable-undo)
1167 (insert-buffer-substring buf
)
1168 (goto-char (point-min))
1169 (while (smerge-find-conflict)
1170 (when (match-beginning 2) (setq base t
))
1172 (buffer-enable-undo)
1173 (set-buffer-modified-p nil
)
1176 (with-current-buffer other
1177 (buffer-disable-undo)
1178 (insert-buffer-substring buf
)
1179 (goto-char (point-min))
1180 (while (smerge-find-conflict)
1182 (buffer-enable-undo)
1183 (set-buffer-modified-p nil
)
1187 (setq base
(generate-new-buffer
1188 (or name-base
(concat "*" filename
" BASE*"))))
1189 (with-current-buffer base
1190 (buffer-disable-undo)
1191 (insert-buffer-substring buf
)
1192 (goto-char (point-min))
1193 (while (smerge-find-conflict)
1196 (delete-region (match-beginning 0) (match-end 0))))
1197 (buffer-enable-undo)
1198 (set-buffer-modified-p nil
)
1201 ;; the rest of the code is inspired from vc.el
1205 (ediff-merge-buffers-with-ancestor mine other base
)
1206 ;; nil 'ediff-merge-revisions-with-ancestor buffer-file-name)
1207 (ediff-merge-buffers mine other
)))
1208 ;; nil 'ediff-merge-revisions buffer-file-name)))
1210 ;; Ediff is now set up, and we are in the control buffer.
1211 ;; Do a few further adjustments and take precautions for exit.
1212 (set (make-local-variable 'smerge-ediff-windows
) config
)
1213 (set (make-local-variable 'smerge-ediff-buf
) buf
)
1214 (set (make-local-variable 'ediff-quit-hook
)
1216 (let ((buffer-A ediff-buffer-A
)
1217 (buffer-B ediff-buffer-B
)
1218 (buffer-C ediff-buffer-C
)
1219 (buffer-Ancestor ediff-ancestor-buffer
)
1220 (buf smerge-ediff-buf
)
1221 (windows smerge-ediff-windows
))
1222 (ediff-cleanup-mess)
1223 (with-current-buffer buf
1225 (insert-buffer-substring buffer-C
)
1226 (kill-buffer buffer-A
)
1227 (kill-buffer buffer-B
)
1228 (kill-buffer buffer-C
)
1229 (when (bufferp buffer-Ancestor
) (kill-buffer buffer-Ancestor
))
1230 (set-window-configuration windows
)
1231 (message "Conflict resolution finished; you may save the buffer")))))
1232 (message "Please resolve conflicts now; exit ediff when done")))
1234 (defun smerge-makeup-conflict (pt1 pt2 pt3
&optional pt4
)
1235 "Insert diff3 markers to make a new conflict.
1236 Uses point and mark for two of the relevant positions and previous marks
1238 By default, makes up a 2-way conflict,
1239 with a \\[universal-argument] prefix, makes up a 3-way conflict."
1243 (progn (pop-mark) (mark))
1244 (when current-prefix-arg
(pop-mark) (mark))))
1245 ;; Start from the end so as to avoid problems with pos-changes.
1246 (destructuring-bind (pt1 pt2 pt3
&optional pt4
)
1247 (sort (list* pt1 pt2 pt3
(if pt4
(list pt4
))) '>=)
1248 (goto-char pt1
) (beginning-of-line)
1249 (insert ">>>>>>> OTHER\n")
1250 (goto-char pt2
) (beginning-of-line)
1251 (insert "=======\n")
1252 (goto-char pt3
) (beginning-of-line)
1254 (insert "||||||| BASE\n")
1255 (goto-char pt4
) (beginning-of-line))
1256 (insert "<<<<<<< MINE\n"))
1257 (if smerge-mode nil
(smerge-mode 1))
1261 (defconst smerge-parsep-re
1262 (concat smerge-begin-re
"\\|" smerge-end-re
"\\|"
1263 smerge-base-re
"\\|" smerge-other-re
"\\|"))
1266 (define-minor-mode smerge-mode
1267 "Minor mode to simplify editing output from the diff3 program.
1268 \\{smerge-mode-map}"
1269 :group
'smerge
:lighter
" SMerge"
1270 (when (and (boundp 'font-lock-mode
) font-lock-mode
)
1273 (font-lock-add-keywords nil smerge-font-lock-keywords
'append
)
1274 (font-lock-remove-keywords nil smerge-font-lock-keywords
))
1275 (goto-char (point-min))
1276 (while (smerge-find-conflict)
1278 (font-lock-fontify-region (match-beginning 0) (match-end 0) nil
)))))
1279 (if (string-match (regexp-quote smerge-parsep-re
) paragraph-separate
)
1281 (set (make-local-variable 'paragraph-separate
)
1282 (replace-match "" t t paragraph-separate
)))
1284 (set (make-local-variable 'paragraph-separate
)
1285 (concat smerge-parsep-re paragraph-separate
))))
1287 (smerge-remove-props (point-min) (point-max))))
1290 (defun smerge-start-session ()
1291 "Turn on `smerge-mode' and move point to first conflict marker.
1292 If no conflict maker is found, turn off `smerge-mode'."
1296 (unless (looking-at smerge-begin-re
)
1298 (error (smerge-auto-leave))))
1300 (provide 'smerge-mode
)
1302 ;;; smerge-mode.el ends here