Commit | Line | Data |
---|---|---|
475f9031 | 1 | ;;; ediff-merg.el --- merging utilities |
b578f267 | 2 | |
0d30b337 | 3 | ;; Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, |
aaef169d | 4 | ;; 2003, 2004, 2005, 2006 Free Software Foundation, Inc. |
475f9031 | 5 | |
50a07e18 | 6 | ;; Author: Michael Kifer <kifer@cs.stonybrook.edu> |
475f9031 KH |
7 | |
8 | ;; This file is part of GNU Emacs. | |
9 | ||
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 2, or (at your option) | |
13 | ;; any later version. | |
14 | ||
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. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
b578f267 | 21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
22 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
23 | ;; Boston, MA 02110-1301, USA. | |
475f9031 | 24 | |
3afbc435 PJ |
25 | ;;; Commentary: |
26 | ||
b578f267 | 27 | ;;; Code: |
475f9031 | 28 | |
ddc90f39 MK |
29 | (provide 'ediff-merg) |
30 | ||
ddc90f39 MK |
31 | ;; compiler pacifier |
32 | (defvar ediff-window-A) | |
33 | (defvar ediff-window-B) | |
34 | (defvar ediff-window-C) | |
35 | (defvar ediff-merge-window-share) | |
36 | (defvar ediff-window-config-saved) | |
37 | ||
38 | (eval-when-compile | |
39 | (let ((load-path (cons (expand-file-name ".") load-path))) | |
40 | (or (featurep 'ediff-init) | |
41 | (load "ediff-init.el" nil nil 'nosuffix)) | |
42 | (or (featurep 'ediff-util) | |
43 | (load "ediff-util.el" nil nil 'nosuffix)) | |
44 | )) | |
45 | ;; end pacifier | |
46 | ||
475f9031 KH |
47 | (require 'ediff-init) |
48 | ||
1e70790f MK |
49 | (defcustom ediff-quit-merge-hook 'ediff-maybe-save-and-delete-merge |
50 | "*Hooks to run before quitting a merge job. | |
51 | The most common use is to save and delete the merge buffer." | |
52 | :type 'hook | |
53 | :group 'ediff-merge) | |
54 | ||
bbe6126c | 55 | |
ddc90f39 | 56 | (defcustom ediff-default-variant 'combined |
475f9031 | 57 | "*The variant to be used as a default for buffer C in merging. |
ddc90f39 MK |
58 | Valid values are the symbols `default-A', `default-B', and `combined'." |
59 | :type '(radio (const default-A) (const default-B) (const combined)) | |
60 | :group 'ediff-merge) | |
475f9031 | 61 | |
71296446 | 62 | (defcustom ediff-combination-pattern |
086171bf | 63 | '("<<<<<<< variant A" A ">>>>>>> variant B" B "####### Ancestor" Ancestor "======= end") |
475f9031 | 64 | "*Pattern to be used for combining difference regions in buffers A and B. |
71296446 | 65 | The value must be a list of the form |
086171bf MK |
66 | (STRING1 bufspec1 STRING2 bufspec2 STRING3 bufspec3 STRING4) |
67 | where bufspec is the symbol A, B, or Ancestor. For instance, if the value is | |
68 | '(STRING1 A STRING2 Ancestor STRING3 B STRING4) then the | |
69 | combined text will look like this: | |
475f9031 KH |
70 | |
71 | STRING1 | |
72 | diff region from variant A | |
73 | STRING2 | |
086171bf | 74 | diff region from the ancestor |
475f9031 | 75 | STRING3 |
086171bf MK |
76 | diff region from variant B |
77 | STRING4 | |
ddc90f39 | 78 | " |
086171bf MK |
79 | :type '(choice (list string symbol string symbol string) |
80 | (list string symbol string symbol string symbol string)) | |
ddc90f39 | 81 | :group 'ediff-merge) |
475f9031 | 82 | |
3af0304a | 83 | (defcustom ediff-show-clashes-only nil |
475f9031 KH |
84 | "*If t, show only those diff regions where both buffers disagree with the ancestor. |
85 | This means that regions that have status prefer-A or prefer-B will be | |
f0529b5b | 86 | skipped over. nil means show all regions." |
3af0304a MK |
87 | :type 'boolean |
88 | :group 'ediff-merge | |
89 | ) | |
90 | (make-variable-buffer-local 'ediff-show-clashes-only) | |
91 | ||
92 | (defcustom ediff-skip-merge-regions-that-differ-from-default nil | |
93 | "*If t, show only the regions that have not been changed by the user. | |
94 | A region is considered to have been changed if it is different from the current | |
95 | default (`default-A', `default-B', `combined') and it hasn't been marked as | |
96 | `prefer-A' or `prefer-B'. | |
71296446 | 97 | A region is considered to have been changed also when it is marked as |
3af0304a MK |
98 | as `prefer-A', but is different from the corresponding difference region in |
99 | Buffer A or if it is marked as `prefer-B' and is different from the region in | |
100 | Buffer B." | |
101 | :type 'boolean | |
102 | :group 'ediff-merge | |
103 | ) | |
104 | (make-variable-buffer-local 'ediff-skip-merge-regions-that-differ-from-default) | |
475f9031 | 105 | |
e2de3a29 | 106 | ;; check if there is no clash between the ancestor and one of the variants. |
39bcfe5f | 107 | ;; if it is not a merge job then return true |
e2de3a29 | 108 | (defsubst ediff-merge-region-is-non-clash (n) |
39bcfe5f MK |
109 | (if (ediff-merge-job) |
110 | (string-match "prefer" (or (ediff-get-state-of-merge n) "")) | |
111 | t)) | |
e2de3a29 | 112 | |
8e41a31c MK |
113 | ;; If ediff-show-clashes-only, check if there is no clash between the ancestor |
114 | ;; and one of the variants. | |
e2de3a29 | 115 | (defsubst ediff-merge-region-is-non-clash-to-skip (n) |
8e41a31c | 116 | (and ediff-show-clashes-only |
e2de3a29 | 117 | (ediff-merge-region-is-non-clash n))) |
8e41a31c | 118 | |
3af0304a MK |
119 | ;; If ediff-skip-changed-regions, check if the merge region differs from |
120 | ;; the current default. If a region is different from the default, it means | |
121 | ;; that the user has made determination as to how to merge for this particular | |
71296446 | 122 | ;; region. |
3af0304a MK |
123 | (defsubst ediff-skip-merge-region-if-changed-from-default-p (n) |
124 | (and ediff-skip-merge-regions-that-differ-from-default | |
125 | (ediff-merge-changed-from-default-p n 'prefers-too))) | |
126 | ||
127 | ||
086171bf MK |
128 | (defun ediff-get-combined-region (n) |
129 | (let ((pattern-list ediff-combination-pattern) | |
130 | (combo-region "") | |
131 | (err-msg | |
132 | "ediff-combination-pattern: Invalid format. Please consult the documentation") | |
50a07e18 | 133 | region-delim region-spec) |
086171bf MK |
134 | |
135 | (if (< (length pattern-list) 5) | |
136 | (error err-msg)) | |
137 | ||
138 | (while (> (length pattern-list) 2) | |
139 | (setq region-delim (nth 0 pattern-list) | |
140 | region-spec (nth 1 pattern-list)) | |
141 | (or (and (stringp region-delim) (memq region-spec '(A B Ancestor))) | |
142 | (error err-msg)) | |
143 | ||
50a07e18 | 144 | (condition-case nil |
086171bf MK |
145 | (setq combo-region |
146 | (concat combo-region | |
147 | region-delim "\n" | |
71296446 | 148 | (ediff-get-region-contents |
086171bf MK |
149 | n region-spec ediff-control-buffer))) |
150 | (error "")) | |
151 | (setq pattern-list (cdr (cdr pattern-list))) | |
152 | ) | |
153 | ||
154 | (setq region-delim (nth 0 pattern-list)) | |
155 | (or (stringp region-delim) | |
156 | (error err-msg)) | |
157 | (setq combo-region (concat combo-region region-delim "\n")) | |
158 | )) | |
159 | ||
160 | ;;(defsubst ediff-make-combined-diff (regA regB) | |
161 | ;; (concat (nth 0 ediff-combination-pattern) "\n" | |
162 | ;; regA | |
163 | ;; (nth 1 ediff-combination-pattern) "\n" | |
164 | ;; regB | |
165 | ;; (nth 2 ediff-combination-pattern) "\n")) | |
009650b3 | 166 | |
475f9031 KH |
167 | (defsubst ediff-set-state-of-all-diffs-in-all-buffers (ctl-buf) |
168 | (let ((n 0)) | |
169 | (while (< n ediff-number-of-differences) | |
170 | (ediff-set-state-of-diff-in-all-buffers n ctl-buf) | |
171 | (setq n (1+ n))))) | |
71296446 | 172 | |
475f9031 KH |
173 | (defun ediff-set-state-of-diff-in-all-buffers (n ctl-buf) |
174 | (let ((regA (ediff-get-region-contents n 'A ctl-buf)) | |
175 | (regB (ediff-get-region-contents n 'B ctl-buf)) | |
176 | (regC (ediff-get-region-contents n 'C ctl-buf))) | |
13340e24 KH |
177 | (cond ((and (string= regA regB) (string= regA regC)) |
178 | (ediff-set-state-of-diff n 'A "=diff(B)") | |
179 | (ediff-set-state-of-diff n 'B "=diff(C)") | |
180 | (ediff-set-state-of-diff n 'C "=diff(A)")) | |
181 | ((string= regA regB) | |
475f9031 KH |
182 | (ediff-set-state-of-diff n 'A "=diff(B)") |
183 | (ediff-set-state-of-diff n 'B "=diff(A)") | |
184 | (ediff-set-state-of-diff n 'C nil)) | |
185 | ((string= regA regC) | |
186 | (ediff-set-state-of-diff n 'A "=diff(C)") | |
187 | (ediff-set-state-of-diff n 'C "=diff(A)") | |
188 | (ediff-set-state-of-diff n 'B nil)) | |
189 | ((string= regB regC) | |
190 | (ediff-set-state-of-diff n 'C "=diff(B)") | |
191 | (ediff-set-state-of-diff n 'B "=diff(C)") | |
192 | (ediff-set-state-of-diff n 'A nil)) | |
193 | ((string= regC (ediff-get-combined-region n)) | |
194 | (ediff-set-state-of-diff n 'A nil) | |
195 | (ediff-set-state-of-diff n 'B nil) | |
196 | (ediff-set-state-of-diff n 'C "=diff(A+B)")) | |
197 | (t (ediff-set-state-of-diff n 'A nil) | |
198 | (ediff-set-state-of-diff n 'B nil) | |
199 | (ediff-set-state-of-diff n 'C nil))) | |
200 | )) | |
71296446 | 201 | |
13340e24 | 202 | (defun ediff-set-merge-mode () |
13340e24 KH |
203 | (normal-mode t) |
204 | (remove-hook 'local-write-file-hooks 'ediff-set-merge-mode)) | |
c439fb30 | 205 | |
71296446 | 206 | |
475f9031 KH |
207 | ;; Go over all diffs starting with DIFF-NUM and copy regions into buffer C |
208 | ;; according to the state of the difference. | |
209 | ;; Since ediff-copy-diff refuses to copy identical diff regions, there is | |
210 | ;; no need to optimize ediff-do-merge any further. | |
211 | ;; | |
212 | ;; If re-merging, change state of merge in all diffs starting with | |
213 | ;; DIFF-NUM, except those where the state is prefer-* or where it is | |
13340e24 KH |
214 | ;; `default-*' or `combined' but the buf C region appears to be modified |
215 | ;; since last set by default. | |
475f9031 KH |
216 | (defun ediff-do-merge (diff-num &optional remerging) |
217 | (if (< diff-num 0) (setq diff-num 0)) | |
218 | (let ((n diff-num) | |
bbe6126c | 219 | ;;(default-state-of-merge (format "%S" ediff-default-variant)) |
13340e24 | 220 | do-not-copy state-of-merge) |
475f9031 | 221 | (while (< n ediff-number-of-differences) |
bbe6126c | 222 | (setq do-not-copy nil) ; reset after each cycle |
475f9031 KH |
223 | (if (= (mod n 10) 0) |
224 | (message "%s buffers A & B into C ... region %d of %d" | |
225 | (if remerging "Re-merging" "Merging") | |
226 | n | |
227 | ediff-number-of-differences)) | |
71296446 | 228 | |
475f9031 | 229 | (setq state-of-merge (ediff-get-state-of-merge n)) |
475f9031 KH |
230 | |
231 | (if remerging | |
50a07e18 MK |
232 | ;;(let ((reg-A (ediff-get-region-contents n 'A ediff-control-buffer)) |
233 | ;; (reg-B (ediff-get-region-contents n 'B ediff-control-buffer)) | |
234 | ;; (reg-C (ediff-get-region-contents n 'C ediff-control-buffer))) | |
235 | (let () | |
71296446 | 236 | |
bbe6126c | 237 | ;; if region was edited since it was first set by default |
3af0304a MK |
238 | (if (or (ediff-merge-changed-from-default-p n) |
239 | ;; was preferred | |
13340e24 | 240 | (string-match "prefer" state-of-merge)) |
3af0304a | 241 | ;; then ignore |
475f9031 | 242 | (setq do-not-copy t)) |
71296446 | 243 | |
475f9031 | 244 | ;; change state of merge for this diff, if necessary |
13340e24 KH |
245 | (if (and (string-match "\\(default\\|combined\\)" state-of-merge) |
246 | (not do-not-copy)) | |
475f9031 KH |
247 | (ediff-set-state-of-merge |
248 | n (format "%S" ediff-default-variant))) | |
249 | )) | |
71296446 | 250 | |
475f9031 | 251 | ;; state-of-merge may have changed via ediff-set-state-of-merge, so |
13340e24 | 252 | ;; check it once again |
475f9031 | 253 | (setq state-of-merge (ediff-get-state-of-merge n)) |
71296446 | 254 | |
475f9031 KH |
255 | (or do-not-copy |
256 | (if (string= state-of-merge "combined") | |
257 | ;; use n+1 because ediff-combine-diffs works via user numbering | |
258 | ;; of diffs, which is 1+ to what ediff uses internally | |
259 | (ediff-combine-diffs (1+ n) 'batch) | |
71296446 | 260 | (ediff-copy-diff |
13340e24 | 261 | n (if (string-match "-A" state-of-merge) 'A 'B) 'C 'batch))) |
475f9031 KH |
262 | (setq n (1+ n))) |
263 | (message "Merging buffers A & B into C ... Done") | |
264 | )) | |
71296446 | 265 | |
475f9031 KH |
266 | |
267 | (defun ediff-re-merge () | |
3af0304a | 268 | "Remerge unmodified diff regions using a new default. Start with the current region." |
475f9031 KH |
269 | (interactive) |
270 | (let* ((default-variant-alist | |
271 | (list '("default-A") '("default-B") '("combined"))) | |
272 | (actual-alist | |
273 | (delete (list (symbol-name ediff-default-variant)) | |
274 | default-variant-alist))) | |
275 | (setq ediff-default-variant | |
276 | (intern | |
71296446 | 277 | (completing-read |
3af0304a | 278 | (format "Current merge default is `%S'. New default: " |
475f9031 KH |
279 | ediff-default-variant) |
280 | actual-alist nil 'must-match))) | |
281 | (ediff-do-merge ediff-current-difference 'remerge) | |
282 | (ediff-recenter) | |
283 | )) | |
71296446 | 284 | |
475f9031 KH |
285 | (defun ediff-shrink-window-C (arg) |
286 | "Shrink window C to just one line. | |
287 | With a prefix argument, returns window C to its normal size. | |
288 | Used only for merging jobs." | |
289 | (interactive "P") | |
290 | (if (not ediff-merge-job) | |
291 | (error "ediff-shrink-window-C can be used only for merging jobs")) | |
292 | (cond ((eq arg '-) (setq arg -1)) | |
293 | ((not (numberp arg)) (setq arg nil))) | |
294 | (cond ((null arg) | |
295 | (let ((ediff-merge-window-share | |
296 | (if (< (window-height ediff-window-C) 3) | |
297 | ediff-merge-window-share 0))) | |
298 | (setq ediff-window-config-saved "") ; force redisplay | |
299 | (ediff-recenter 'no-rehighlight))) | |
300 | ((and (< arg 0) (> (window-height ediff-window-C) 2)) | |
301 | (setq ediff-merge-window-share (* ediff-merge-window-share 0.9)) | |
302 | (setq ediff-window-config-saved "") ; force redisplay | |
303 | (ediff-recenter 'no-rehighlight)) | |
304 | ((and (> arg 0) (> (window-height ediff-window-A) 2)) | |
305 | (setq ediff-merge-window-share (* ediff-merge-window-share 1.1)) | |
306 | (setq ediff-window-config-saved "") ; force redisplay | |
307 | (ediff-recenter 'no-rehighlight)))) | |
308 | ||
309 | ||
3af0304a | 310 | ;; N here is the user's region number. It is 1+ what Ediff uses internally. |
475f9031 KH |
311 | (defun ediff-combine-diffs (n &optional batch-invocation) |
312 | "Combine Nth diff regions of buffers A and B and place the combination in C. | |
3af0304a | 313 | N is a prefix argument. If nil, combine the current difference regions. |
4ae69eac MK |
314 | Combining is done according to the specifications in variable |
315 | `ediff-combination-pattern'." | |
475f9031 | 316 | (interactive "P") |
4ae69eac | 317 | (setq n (if (numberp n) (1- n) ediff-current-difference)) |
71296446 | 318 | |
50a07e18 | 319 | (let (reg-combined) |
086171bf MK |
320 | ;;(setq regA (ediff-get-region-contents n 'A ediff-control-buffer) |
321 | ;; regB (ediff-get-region-contents n 'B ediff-control-buffer)) | |
322 | ;;(setq reg-combined (ediff-make-combined-diff regA regB)) | |
323 | (setq reg-combined (ediff-get-combined-region n)) | |
71296446 | 324 | |
475f9031 | 325 | (ediff-copy-diff n nil 'C batch-invocation reg-combined)) |
4ae69eac | 326 | (or batch-invocation (ediff-jump-to-difference (1+ n)))) |
71296446 | 327 | |
475f9031 KH |
328 | |
329 | ;; Checks if the region in buff C looks like a combination of the regions | |
3af0304a | 330 | ;; in buffers A and B. Return a list (reg-a-beg reg-a-end reg-b-beg reg-b-end) |
086171bf MK |
331 | ;; These refer to where the delimiters for region A, B, Ancestor start and end |
332 | ;; in buffer C | |
475f9031 KH |
333 | (defun ediff-looks-like-combined-merge (region-num) |
334 | (if ediff-merge-job | |
335 | (let ((combined (string-match (regexp-quote "(A+B)") | |
336 | (or (ediff-get-state-of-diff region-num 'C) | |
337 | ""))) | |
086171bf MK |
338 | (mrgreg-beg (ediff-get-diff-posn 'C 'beg region-num)) |
339 | (mrgreg-end (ediff-get-diff-posn 'C 'end region-num)) | |
340 | (pattern-list ediff-combination-pattern) | |
341 | delim reg-beg reg-end delim-regs-list) | |
71296446 | 342 | |
475f9031 | 343 | (if combined |
e756eb9f | 344 | (ediff-with-current-buffer ediff-buffer-C |
086171bf MK |
345 | (while pattern-list |
346 | (goto-char mrgreg-beg) | |
347 | (setq delim (nth 0 pattern-list)) | |
348 | (search-forward delim mrgreg-end 'noerror) | |
349 | (setq reg-beg (match-beginning 0)) | |
350 | (setq reg-end (match-end 0)) | |
351 | (if (and reg-beg reg-end) | |
352 | (setq delim-regs-list | |
353 | ;; in reverse | |
354 | (cons reg-end (cons reg-beg delim-regs-list)))) | |
355 | (if (> (length pattern-list) 1) | |
356 | (setq pattern-list (cdr (cdr pattern-list))) | |
357 | (setq pattern-list nil)) | |
358 | ))) | |
359 | ||
360 | (reverse delim-regs-list) | |
475f9031 | 361 | ))) |
3b90e5b8 DL |
362 | |
363 | (eval-when-compile (defvar state-of-merge)) ; dynamic var | |
3af0304a MK |
364 | |
365 | ;; Check if the non-preferred merge has been modified since originally set. | |
366 | ;; This affects only the regions that are marked as default-A/B or combined. | |
367 | ;; If PREFERS-TOO is non-nil, then look at the regions marked as prefers-A/B as | |
368 | ;; well. | |
369 | (defun ediff-merge-changed-from-default-p (diff-num &optional prefers-too) | |
370 | (let ((reg-A (ediff-get-region-contents diff-num 'A ediff-control-buffer)) | |
371 | (reg-B (ediff-get-region-contents diff-num 'B ediff-control-buffer)) | |
372 | (reg-C (ediff-get-region-contents diff-num 'C ediff-control-buffer))) | |
373 | ||
374 | (setq state-of-merge (ediff-get-state-of-merge diff-num)) | |
71296446 | 375 | |
3af0304a MK |
376 | ;; if region was edited since it was first set by default |
377 | (or (and (string= state-of-merge "default-A") | |
378 | (not (string= reg-A reg-C))) | |
379 | (and (string= state-of-merge "default-B") | |
380 | (not (string= reg-B reg-C))) | |
381 | (and (string= state-of-merge "combined") | |
086171bf MK |
382 | ;;(not (string= (ediff-make-combined-diff reg-A reg-B) reg-C))) |
383 | (not (string= (ediff-get-combined-region diff-num) reg-C))) | |
3af0304a MK |
384 | (and prefers-too |
385 | (string= state-of-merge "prefer-A") | |
386 | (not (string= reg-A reg-C))) | |
387 | (and prefers-too | |
388 | (string= state-of-merge "prefer-B") | |
389 | (not (string= reg-B reg-C))) | |
390 | ))) | |
71296446 | 391 | |
475f9031 | 392 | |
92c51e07 MK |
393 | ;;; Local Variables: |
394 | ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun) | |
e756eb9f MK |
395 | ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1) |
396 | ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body)) | |
92c51e07 MK |
397 | ;;; End: |
398 | ||
ab5796a9 | 399 | ;;; arch-tag: 9b798cf9-02ba-487f-a62e-b63aa823dbfb |
3afbc435 | 400 | ;;; ediff-merg.el ends here |