1 ;;; ediff-merg.el --- merging utilities
3 ;; Copyright (C) 1994, 1995, 1996, 1997 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.sunysb.edu>
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING. If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
29 (defvar ediff-window-A
)
30 (defvar ediff-window-B
)
31 (defvar ediff-window-C
)
32 (defvar ediff-merge-window-share
)
33 (defvar ediff-window-config-saved
)
36 (let ((load-path (cons (expand-file-name ".") load-path
)))
37 (or (featurep 'ediff-init
)
38 (load "ediff-init.el" nil nil
'nosuffix
))
39 (or (featurep 'ediff-util
)
40 (load "ediff-util.el" nil nil
'nosuffix
))
46 (defcustom ediff-quit-merge-hook
'ediff-maybe-save-and-delete-merge
47 "*Hooks to run before quitting a merge job.
48 The most common use is to save and delete the merge buffer."
53 (defcustom ediff-default-variant
'combined
54 "*The variant to be used as a default for buffer C in merging.
55 Valid values are the symbols `default-A', `default-B', and `combined'."
56 :type
'(radio (const default-A
) (const default-B
) (const combined
))
59 (defcustom ediff-combination-pattern
60 '("<<<<<<<<<<<<<< variant A" ">>>>>>>>>>>>>> variant B" "======= end of combination")
61 "*Pattern to be used for combining difference regions in buffers A and B.
62 The value is (STRING1 STRING2 STRING3). The combined text will look like this:
65 diff region from variant A
67 diff region from variant B
70 :type
'(list string string string
)
73 (defcustom ediff-show-clashes-only nil
74 "*If t, show only those diff regions where both buffers disagree with the ancestor.
75 This means that regions that have status prefer-A or prefer-B will be
76 skiped over. Nil means show all regions."
80 (make-variable-buffer-local 'ediff-show-clashes-only
)
82 (defcustom ediff-skip-merge-regions-that-differ-from-default nil
83 "*If t, show only the regions that have not been changed by the user.
84 A region is considered to have been changed if it is different from the current
85 default (`default-A', `default-B', `combined') and it hasn't been marked as
86 `prefer-A' or `prefer-B'.
87 A region is considered to have been changed also when it is marked as
88 as `prefer-A', but is different from the corresponding difference region in
89 Buffer A or if it is marked as `prefer-B' and is different from the region in
94 (make-variable-buffer-local 'ediff-skip-merge-regions-that-differ-from-default
)
96 ;; If ediff-show-clashes-only, check if there is no clash between the ancestor
97 ;; and one of the variants.
98 (defsubst ediff-merge-region-is-non-clash
(n)
99 (and ediff-show-clashes-only
100 (string-match "prefer" (or (ediff-get-state-of-merge n
) ""))))
102 ;; If ediff-skip-changed-regions, check if the merge region differs from
103 ;; the current default. If a region is different from the default, it means
104 ;; that the user has made determination as to how to merge for this particular
106 (defsubst ediff-skip-merge-region-if-changed-from-default-p
(n)
107 (and ediff-skip-merge-regions-that-differ-from-default
108 (ediff-merge-changed-from-default-p n
'prefers-too
)))
112 (defsubst ediff-get-combined-region
(n)
113 (concat (nth 0 ediff-combination-pattern
) "\n"
114 (ediff-get-region-contents n
'A ediff-control-buffer
)
115 (nth 1 ediff-combination-pattern
) "\n"
116 (ediff-get-region-contents n
'B ediff-control-buffer
)
117 (nth 2 ediff-combination-pattern
) "\n"))
119 (defsubst ediff-make-combined-diff
(regA regB
)
120 (concat (nth 0 ediff-combination-pattern
) "\n"
122 (nth 1 ediff-combination-pattern
) "\n"
124 (nth 2 ediff-combination-pattern
) "\n"))
126 (defsubst ediff-set-state-of-all-diffs-in-all-buffers
(ctl-buf)
128 (while (< n ediff-number-of-differences
)
129 (ediff-set-state-of-diff-in-all-buffers n ctl-buf
)
132 (defun ediff-set-state-of-diff-in-all-buffers (n ctl-buf
)
133 (let ((regA (ediff-get-region-contents n
'A ctl-buf
))
134 (regB (ediff-get-region-contents n
'B ctl-buf
))
135 (regC (ediff-get-region-contents n
'C ctl-buf
)))
136 (cond ((and (string= regA regB
) (string= regA regC
))
137 (ediff-set-state-of-diff n
'A
"=diff(B)")
138 (ediff-set-state-of-diff n
'B
"=diff(C)")
139 (ediff-set-state-of-diff n
'C
"=diff(A)"))
141 (ediff-set-state-of-diff n
'A
"=diff(B)")
142 (ediff-set-state-of-diff n
'B
"=diff(A)")
143 (ediff-set-state-of-diff n
'C nil
))
145 (ediff-set-state-of-diff n
'A
"=diff(C)")
146 (ediff-set-state-of-diff n
'C
"=diff(A)")
147 (ediff-set-state-of-diff n
'B nil
))
149 (ediff-set-state-of-diff n
'C
"=diff(B)")
150 (ediff-set-state-of-diff n
'B
"=diff(C)")
151 (ediff-set-state-of-diff n
'A nil
))
152 ((string= regC
(ediff-get-combined-region n
))
153 (ediff-set-state-of-diff n
'A nil
)
154 (ediff-set-state-of-diff n
'B nil
)
155 (ediff-set-state-of-diff n
'C
"=diff(A+B)"))
156 (t (ediff-set-state-of-diff n
'A nil
)
157 (ediff-set-state-of-diff n
'B nil
)
158 (ediff-set-state-of-diff n
'C nil
)))
161 (defun ediff-set-merge-mode ()
163 (remove-hook 'local-write-file-hooks
'ediff-set-merge-mode
))
166 ;; Go over all diffs starting with DIFF-NUM and copy regions into buffer C
167 ;; according to the state of the difference.
168 ;; Since ediff-copy-diff refuses to copy identical diff regions, there is
169 ;; no need to optimize ediff-do-merge any further.
171 ;; If re-merging, change state of merge in all diffs starting with
172 ;; DIFF-NUM, except those where the state is prefer-* or where it is
173 ;; `default-*' or `combined' but the buf C region appears to be modified
174 ;; since last set by default.
175 (defun ediff-do-merge (diff-num &optional remerging
)
176 (if (< diff-num
0) (setq diff-num
0))
178 ;;(default-state-of-merge (format "%S" ediff-default-variant))
179 do-not-copy state-of-merge
)
180 (while (< n ediff-number-of-differences
)
181 (setq do-not-copy nil
) ; reset after each cycle
183 (message "%s buffers A & B into C ... region %d of %d"
184 (if remerging
"Re-merging" "Merging")
186 ediff-number-of-differences
))
188 (setq state-of-merge
(ediff-get-state-of-merge n
))
191 (let ((reg-A (ediff-get-region-contents n
'A ediff-control-buffer
))
192 (reg-B (ediff-get-region-contents n
'B ediff-control-buffer
))
193 (reg-C (ediff-get-region-contents n
'C ediff-control-buffer
)))
195 ;; if region was edited since it was first set by default
196 (if (or (ediff-merge-changed-from-default-p n
)
198 (string-match "prefer" state-of-merge
))
200 (setq do-not-copy t
))
202 ;; change state of merge for this diff, if necessary
203 (if (and (string-match "\\(default\\|combined\\)" state-of-merge
)
205 (ediff-set-state-of-merge
206 n
(format "%S" ediff-default-variant
)))
209 ;; state-of-merge may have changed via ediff-set-state-of-merge, so
210 ;; check it once again
211 (setq state-of-merge
(ediff-get-state-of-merge n
))
214 (if (string= state-of-merge
"combined")
215 ;; use n+1 because ediff-combine-diffs works via user numbering
216 ;; of diffs, which is 1+ to what ediff uses internally
217 (ediff-combine-diffs (1+ n
) 'batch
)
219 n
(if (string-match "-A" state-of-merge
) 'A
'B
) 'C
'batch
)))
221 (message "Merging buffers A & B into C ... Done")
225 (defun ediff-re-merge ()
226 "Remerge unmodified diff regions using a new default. Start with the current region."
228 (let* ((default-variant-alist
229 (list '("default-A") '("default-B") '("combined")))
231 (delete (list (symbol-name ediff-default-variant
))
232 default-variant-alist
)))
233 (setq ediff-default-variant
236 (format "Current merge default is `%S'. New default: "
237 ediff-default-variant
)
238 actual-alist nil
'must-match
)))
239 (ediff-do-merge ediff-current-difference
'remerge
)
243 (defun ediff-shrink-window-C (arg)
244 "Shrink window C to just one line.
245 With a prefix argument, returns window C to its normal size.
246 Used only for merging jobs."
248 (if (not ediff-merge-job
)
249 (error "ediff-shrink-window-C can be used only for merging jobs"))
250 (cond ((eq arg
'-
) (setq arg -
1))
251 ((not (numberp arg
)) (setq arg nil
)))
253 (let ((ediff-merge-window-share
254 (if (< (window-height ediff-window-C
) 3)
255 ediff-merge-window-share
0)))
256 (setq ediff-window-config-saved
"") ; force redisplay
257 (ediff-recenter 'no-rehighlight
)))
258 ((and (< arg
0) (> (window-height ediff-window-C
) 2))
259 (setq ediff-merge-window-share
(* ediff-merge-window-share
0.9))
260 (setq ediff-window-config-saved
"") ; force redisplay
261 (ediff-recenter 'no-rehighlight
))
262 ((and (> arg
0) (> (window-height ediff-window-A
) 2))
263 (setq ediff-merge-window-share
(* ediff-merge-window-share
1.1))
264 (setq ediff-window-config-saved
"") ; force redisplay
265 (ediff-recenter 'no-rehighlight
))))
268 ;; N here is the user's region number. It is 1+ what Ediff uses internally.
269 (defun ediff-combine-diffs (n &optional batch-invocation
)
270 "Combine Nth diff regions of buffers A and B and place the combination in C.
271 N is a prefix argument. If nil, combine the current difference regions.
272 Combining is done according to the specifications in variable
273 `ediff-combination-pattern'."
275 (setq n
(if (numberp n
) (1- n
) ediff-current-difference
))
277 (let (regA regB reg-combined
)
278 (setq regA
(ediff-get-region-contents n
'A ediff-control-buffer
)
279 regB
(ediff-get-region-contents n
'B ediff-control-buffer
))
281 (setq reg-combined
(ediff-make-combined-diff regA regB
))
283 (ediff-copy-diff n nil
'C batch-invocation reg-combined
))
284 (or batch-invocation
(ediff-jump-to-difference (1+ n
))))
287 ;; Checks if the region in buff C looks like a combination of the regions
288 ;; in buffers A and B. Return a list (reg-a-beg reg-a-end reg-b-beg reg-b-end)
289 ;; These refer to where the copies of region A and B start and end in buffer C
290 (defun ediff-looks-like-combined-merge (region-num)
292 (let ((combined (string-match (regexp-quote "(A+B)")
293 (or (ediff-get-state-of-diff region-num
'C
)
295 (reg-beg (ediff-get-diff-posn 'C
'beg region-num
))
296 (reg-end (ediff-get-diff-posn 'C
'end region-num
))
297 (pat1 (nth 0 ediff-combination-pattern
))
298 (pat2 (nth 1 ediff-combination-pattern
))
299 (pat3 (nth 2 ediff-combination-pattern
))
300 reg-a-beg reg-a-end reg-b-beg reg-b-end reg-c-beg reg-c-end
)
303 (ediff-with-current-buffer ediff-buffer-C
305 (search-forward pat1 reg-end
'noerror
)
306 (setq reg-a-beg
(match-beginning 0))
307 (setq reg-a-end
(match-end 0))
308 (search-forward pat2 reg-end
'noerror
)
309 (setq reg-b-beg
(match-beginning 0))
310 (setq reg-b-end
(match-end 0))
311 (search-forward pat3 reg-end
'noerror
)
312 (setq reg-c-beg
(match-beginning 0))
313 (setq reg-c-end
(match-end 0))))
315 (if (and reg-a-beg reg-a-end reg-b-beg reg-b-end
)
316 (list reg-a-beg reg-a-end reg-b-beg reg-b-end reg-c-beg reg-c-end
))
320 ;; Check if the non-preferred merge has been modified since originally set.
321 ;; This affects only the regions that are marked as default-A/B or combined.
322 ;; If PREFERS-TOO is non-nil, then look at the regions marked as prefers-A/B as
324 (defun ediff-merge-changed-from-default-p (diff-num &optional prefers-too
)
325 (let ((reg-A (ediff-get-region-contents diff-num
'A ediff-control-buffer
))
326 (reg-B (ediff-get-region-contents diff-num
'B ediff-control-buffer
))
327 (reg-C (ediff-get-region-contents diff-num
'C ediff-control-buffer
)))
329 (setq state-of-merge
(ediff-get-state-of-merge diff-num
))
331 ;; if region was edited since it was first set by default
332 (or (and (string= state-of-merge
"default-A")
333 (not (string= reg-A reg-C
)))
334 (and (string= state-of-merge
"default-B")
335 (not (string= reg-B reg-C
)))
336 (and (string= state-of-merge
"combined")
337 (not (string= (ediff-make-combined-diff reg-A reg-B
) reg-C
)))
339 (string= state-of-merge
"prefer-A")
340 (not (string= reg-A reg-C
)))
342 (string= state-of-merge
"prefer-B")
343 (not (string= reg-B reg-C
)))
348 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
349 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
350 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
353 ;; ediff-merg.el ends here