[bpt/emacs.git] / lisp / ediff-merg.el

;;; ediff-merg.el --- merging utilities

;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.

;; Author: Michael Kifer <kifer@cs.sunysb.edu>

;; This file is part of GNU Emacs.

;; 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 2, 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
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; 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., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.

;;; Code:

(require 'ediff-init)

(defvar ediff-default-variant 'default-A
  "*The variant to be used as a default for buffer C in merging.
Valid values are the symbols `default-A', `default-B', and `combined'.")

(defvar ediff-combination-pattern 
  '("#ifdef NEW /* variant A */" "#else /* variant B */" "#endif /* NEW */")
  "*Pattern to be used for combining difference regions in buffers A and B.
The value is (STRING1 STRING2 STRING3). The combined text will look like this:

STRING1
diff region from variant A
STRING2
diff region from variant B
STRING3
")

(ediff-defvar-local ediff-show-clashes-only  nil
  "*If t, show only those diff regions where both buffers disagree with the ancestor.
This means that regions that have status prefer-A or prefer-B will be
skiped over. Nil means show all regions.")

	
(defsubst ediff-get-combined-region (n)
  (concat (nth 0 ediff-combination-pattern) "\n"
	  (ediff-get-region-contents n 'A ediff-control-buffer)
	  (nth 1 ediff-combination-pattern) "\n"
	  (ediff-get-region-contents n 'B ediff-control-buffer)
	  (nth 2 ediff-combination-pattern) "\n"))

(defsubst ediff-make-combined-diff (regA regB)
  (concat (nth 0 ediff-combination-pattern) "\n"
	  regA
	  (nth 1 ediff-combination-pattern) "\n"
	  regB
	  (nth 2 ediff-combination-pattern) "\n"))

(defsubst ediff-set-state-of-all-diffs-in-all-buffers (ctl-buf)
  (let ((n 0))
    (while (< n ediff-number-of-differences)
      (ediff-set-state-of-diff-in-all-buffers n ctl-buf)
      (setq n (1+ n)))))
     
(defun ediff-set-state-of-diff-in-all-buffers (n ctl-buf)
  (let ((regA (ediff-get-region-contents n 'A ctl-buf))
	(regB (ediff-get-region-contents n 'B ctl-buf))
	(regC (ediff-get-region-contents n 'C ctl-buf)))
    (cond ((and (string= regA regB) (string= regA  regC))
	   (ediff-set-state-of-diff n 'A "=diff(B)")
	   (ediff-set-state-of-diff n 'B "=diff(C)")
	   (ediff-set-state-of-diff n 'C "=diff(A)"))
	  ((string= regA regB)
	   (ediff-set-state-of-diff n 'A "=diff(B)")
	   (ediff-set-state-of-diff n 'B "=diff(A)")
	   (ediff-set-state-of-diff n 'C nil))
	  ((string= regA regC)
	   (ediff-set-state-of-diff n 'A "=diff(C)")
	   (ediff-set-state-of-diff n 'C "=diff(A)")
	   (ediff-set-state-of-diff n 'B nil))
	  ((string= regB regC)
	   (ediff-set-state-of-diff n 'C "=diff(B)")
	   (ediff-set-state-of-diff n 'B "=diff(C)")
	   (ediff-set-state-of-diff n 'A nil))
	  ((string= regC (ediff-get-combined-region n))
	   (ediff-set-state-of-diff n 'A nil)
	     (ediff-set-state-of-diff n 'B nil)
	     (ediff-set-state-of-diff n 'C "=diff(A+B)"))
	  (t (ediff-set-state-of-diff n 'A nil)
	     (ediff-set-state-of-diff n 'B nil)
	     (ediff-set-state-of-diff n 'C nil)))
    ))
    
(defun ediff-set-merge-mode ()
  ;; by Stig@hackvan.com
  (normal-mode t)
  (remove-hook 'local-write-file-hooks 'ediff-set-merge-mode))

	
;; Go over all diffs starting with DIFF-NUM and copy regions into buffer C
;; according to the state of the difference.
;; Since ediff-copy-diff refuses to copy identical diff regions, there is
;; no need to optimize ediff-do-merge any further.
;;
;; If re-merging, change state of merge in all diffs starting with
;; DIFF-NUM, except those where the state is prefer-* or where it is
;; `default-*' or `combined' but the buf C region appears to be modified
;; since last set by default.
(defun ediff-do-merge (diff-num &optional remerging)
  (if (< diff-num 0) (setq diff-num 0))
  (let ((n diff-num)
	(default-state-of-merge (format "%S" ediff-default-variant))
	do-not-copy state-of-merge)
    (while (< n ediff-number-of-differences)
      (if (= (mod n 10) 0)
	  (message "%s buffers A & B into C ... region %d of %d"
		   (if remerging "Re-merging" "Merging")
		   n
		   ediff-number-of-differences))
	     
      (setq state-of-merge (ediff-get-state-of-merge n))

      (if remerging
	  (let ((reg-A (ediff-get-region-contents n 'A ediff-control-buffer))
		(reg-B (ediff-get-region-contents n 'B ediff-control-buffer))
		(reg-C (ediff-get-region-contents n 'C ediff-control-buffer)))
		
		    ;;; was edited since first set by default
	    (if (or (and (string= state-of-merge "default-A")
		      (not (string= reg-A reg-C)))
		    ;; was edited since first set by default
		    (and (string= state-of-merge "default-B")
			 (not (string= reg-B reg-C)))
		    ;; was edited since first set by default
		    (and (string= state-of-merge "combined")
			 (not (string=
			       (ediff-make-combined-diff reg-A reg-B) reg-C)))
		    ;; was preferred--ignore
		    (string-match "prefer" state-of-merge))
		(setq do-not-copy t))
		
	    ;; change state of merge for this diff, if necessary
	    (if (and (string-match "\\(default\\|combined\\)" state-of-merge)
		     (not do-not-copy))
		(ediff-set-state-of-merge
		 n (format "%S" ediff-default-variant)))
	    ))
	  
      ;; state-of-merge may have changed via ediff-set-state-of-merge, so
      ;; check it once again
      (setq state-of-merge (ediff-get-state-of-merge n))
      
      (or do-not-copy
	  (if (string= state-of-merge "combined")
	      ;; use n+1 because ediff-combine-diffs works via user numbering
	      ;; of diffs, which is 1+ to what ediff uses internally
	      (ediff-combine-diffs (1+ n) 'batch)
	    (ediff-copy-diff 
	     n (if (string-match "-A" state-of-merge) 'A 'B) 'C 'batch)))
      (setq n (1+ n)))
    (message "Merging buffers A & B into C ... Done")
    ))
    

(defun ediff-re-merge ()
  "Remerge unmodified diff regions using a new default. Start with the current region."
  (interactive)
  (let* ((default-variant-alist
	   (list '("default-A") '("default-B") '("combined")))
	 (actual-alist
	  (delete (list (symbol-name ediff-default-variant))
		  default-variant-alist)))
    (setq ediff-default-variant
	  (intern
	   (completing-read 
	    (format "Current merge default is `%S'. New default: "
		    ediff-default-variant)
	    actual-alist nil 'must-match)))
    (ediff-do-merge ediff-current-difference 'remerge)
    (ediff-recenter)
  ))
    
(defun ediff-shrink-window-C (arg)
  "Shrink window C to just one line.
With a prefix argument, returns window C to its normal size.
Used only for merging jobs."
  (interactive "P")
  (if (not ediff-merge-job)
      (error "ediff-shrink-window-C can be used only for merging jobs"))
  (cond ((eq arg '-) (setq arg -1))
	((not (numberp arg)) (setq arg nil)))
  (cond ((null arg)
	 (let ((ediff-merge-window-share
		(if (< (window-height ediff-window-C) 3)
		    ediff-merge-window-share 0)))
	   (setq ediff-window-config-saved "") ; force redisplay
	   (ediff-recenter 'no-rehighlight)))
	((and (< arg 0) (> (window-height ediff-window-C) 2))
	 (setq ediff-merge-window-share (* ediff-merge-window-share 0.9))
	 (setq ediff-window-config-saved "") ; force redisplay
	 (ediff-recenter 'no-rehighlight))
	((and (> arg 0) (> (window-height ediff-window-A) 2))
	 (setq ediff-merge-window-share (* ediff-merge-window-share 1.1))
	 (setq ediff-window-config-saved "") ; force redisplay
	 (ediff-recenter 'no-rehighlight))))


;; N here is the user's region number. It is 1+ what Ediff uses internally.
(defun ediff-combine-diffs (n &optional batch-invocation)
  "Combine Nth diff regions of buffers A and B and place the combination in C.
Combining is done using the list in variable `ediff-combination-pattern'."
  (interactive "P")
  (setq n (if n (1- n) ediff-current-difference))
  
  (let (regA regB reg-combined)
    (setq regA (ediff-get-region-contents n 'A ediff-control-buffer)
	  regB (ediff-get-region-contents n 'B ediff-control-buffer))
    
    (setq reg-combined (ediff-make-combined-diff regA regB))
    
    (ediff-copy-diff n nil 'C batch-invocation reg-combined))
    (or batch-invocation (ediff-recenter)))
    

;; Checks if the region in buff C looks like a combination of the regions
;; in buffers A and B. Returns a list (reg-a-beg reg-a-end reg-b-beg reg-b-end)
;; These refer to where the copies of region A and B start and end in buffer C
(defun ediff-looks-like-combined-merge (region-num)
  (if ediff-merge-job
      (let ((combined (string-match (regexp-quote "(A+B)")
				    (or (ediff-get-state-of-diff region-num 'C)
					"")))
	    (reg-beg (ediff-get-diff-posn 'C 'beg region-num))
	    (reg-end (ediff-get-diff-posn 'C 'end region-num))
	    (pat1 (nth 0 ediff-combination-pattern))
	    (pat2 (nth 1 ediff-combination-pattern))
	    (pat3 (nth 2 ediff-combination-pattern))
	    reg-a-beg reg-a-end reg-b-beg reg-b-end reg-c-beg reg-c-end)
	
	(if combined
	    (ediff-eval-in-buffer ediff-buffer-C
	      (goto-char reg-beg)
	      (search-forward pat1 reg-end 'noerror)
	      (setq reg-a-beg (match-beginning 0))
	      (setq reg-a-end (match-end 0))
	      (search-forward pat2 reg-end 'noerror)
	      (setq reg-b-beg (match-beginning 0))
	      (setq reg-b-end (match-end 0))
	      (search-forward pat3 reg-end 'noerror)
	      (setq reg-c-beg (match-beginning 0))
	      (setq reg-c-end (match-end 0))))
	
	(if (and reg-a-beg reg-a-end reg-b-beg reg-b-end)
	    (list reg-a-beg reg-a-end reg-b-beg reg-b-end reg-c-beg reg-c-end))
	)))
  

(provide 'ediff-merg)

;; ediff-merg.el ends here
Commit	Line	Data
475f9031	1	;;; ediff-merg.el --- merging utilities
b578f267 EN	2
b578f267 EN	3	;; Copyright (C) 1994, 1995 Free Software Foundation, Inc.
475f9031 KH	4
	5	;; Author: Michael Kifer <kifer@cs.sunysb.edu>
	6
	7	;; This file is part of GNU Emacs.
	8
	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)
	12	;; any later version.
	13
	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.
	18
	19	;; You should have received a copy of the GNU General Public License
b578f267 EN	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.
475f9031	23
b578f267	24	;;; Code:
475f9031 KH	25
	26	(require 'ediff-init)
	27
475f9031 KH	28	(defvar ediff-default-variant 'default-A
	29	"*The variant to be used as a default for buffer C in merging.
	30	Valid values are the symbols `default-A', `default-B', and `combined'.")
	31
	32	(defvar ediff-combination-pattern
	33	'("#ifdef NEW /* variant A /" "#else / variant B /" "#endif / NEW */")
	34	"*Pattern to be used for combining difference regions in buffers A and B.
	35	The value is (STRING1 STRING2 STRING3). The combined text will look like this:
	36
	37	STRING1
	38	diff region from variant A
	39	STRING2
	40	diff region from variant B
	41	STRING3
	42	")
	43
	44	(ediff-defvar-local ediff-show-clashes-only nil
	45	"*If t, show only those diff regions where both buffers disagree with the ancestor.
	46	This means that regions that have status prefer-A or prefer-B will be
	47	skiped over. Nil means show all regions.")
	48
	49
	50	(defsubst ediff-get-combined-region (n)
	51	(concat (nth 0 ediff-combination-pattern) "\n"
	52	(ediff-get-region-contents n 'A ediff-control-buffer)
	53	(nth 1 ediff-combination-pattern) "\n"
	54	(ediff-get-region-contents n 'B ediff-control-buffer)
	55	(nth 2 ediff-combination-pattern) "\n"))
009650b3 MK	56
	57	(defsubst ediff-make-combined-diff (regA regB)
	58	(concat (nth 0 ediff-combination-pattern) "\n"
	59	regA
	60	(nth 1 ediff-combination-pattern) "\n"
	61	regB
	62	(nth 2 ediff-combination-pattern) "\n"))
	63
475f9031 KH	64	(defsubst ediff-set-state-of-all-diffs-in-all-buffers (ctl-buf)
	65	(let ((n 0))
	66	(while (< n ediff-number-of-differences)
	67	(ediff-set-state-of-diff-in-all-buffers n ctl-buf)
	68	(setq n (1+ n)))))
	69
	70	(defun ediff-set-state-of-diff-in-all-buffers (n ctl-buf)
	71	(let ((regA (ediff-get-region-contents n 'A ctl-buf))
	72	(regB (ediff-get-region-contents n 'B ctl-buf))
	73	(regC (ediff-get-region-contents n 'C ctl-buf)))
13340e24 KH	74	(cond ((and (string= regA regB) (string= regA regC))
	75	(ediff-set-state-of-diff n 'A "=diff(B)")
	76	(ediff-set-state-of-diff n 'B "=diff(C)")
	77	(ediff-set-state-of-diff n 'C "=diff(A)"))
	78	((string= regA regB)
475f9031 KH	79	(ediff-set-state-of-diff n 'A "=diff(B)")
	80	(ediff-set-state-of-diff n 'B "=diff(A)")
	81	(ediff-set-state-of-diff n 'C nil))
	82	((string= regA regC)
	83	(ediff-set-state-of-diff n 'A "=diff(C)")
	84	(ediff-set-state-of-diff n 'C "=diff(A)")
	85	(ediff-set-state-of-diff n 'B nil))
	86	((string= regB regC)
	87	(ediff-set-state-of-diff n 'C "=diff(B)")
	88	(ediff-set-state-of-diff n 'B "=diff(C)")
	89	(ediff-set-state-of-diff n 'A nil))
	90	((string= regC (ediff-get-combined-region n))
	91	(ediff-set-state-of-diff n 'A nil)
	92	(ediff-set-state-of-diff n 'B nil)
	93	(ediff-set-state-of-diff n 'C "=diff(A+B)"))
	94	(t (ediff-set-state-of-diff n 'A nil)
	95	(ediff-set-state-of-diff n 'B nil)
	96	(ediff-set-state-of-diff n 'C nil)))
	97	))
13340e24 KH	98
	99	(defun ediff-set-merge-mode ()
	100	;; by Stig@hackvan.com
	101	(normal-mode t)
	102	(remove-hook 'local-write-file-hooks 'ediff-set-merge-mode))
c439fb30	103
475f9031 KH	104
	105	;; Go over all diffs starting with DIFF-NUM and copy regions into buffer C
	106	;; according to the state of the difference.
	107	;; Since ediff-copy-diff refuses to copy identical diff regions, there is
	108	;; no need to optimize ediff-do-merge any further.
	109	;;
	110	;; If re-merging, change state of merge in all diffs starting with
	111	;; DIFF-NUM, except those where the state is prefer-* or where it is
13340e24 KH	112	;; `default-*' or `combined' but the buf C region appears to be modified
13340e24 KH	113	;; since last set by default.
475f9031 KH	114	(defun ediff-do-merge (diff-num &optional remerging)
	115	(if (< diff-num 0) (setq diff-num 0))
	116	(let ((n diff-num)
	117	(default-state-of-merge (format "%S" ediff-default-variant))
13340e24	118	do-not-copy state-of-merge)
475f9031	119	(while (< n ediff-number-of-differences)
475f9031 KH	120	(if (= (mod n 10) 0)
	121	(message "%s buffers A & B into C ... region %d of %d"
	122	(if remerging "Re-merging" "Merging")
	123	n
	124	ediff-number-of-differences))
	125
	126	(setq state-of-merge (ediff-get-state-of-merge n))
475f9031 KH	127
	128	(if remerging
	129	(let ((reg-A (ediff-get-region-contents n 'A ediff-control-buffer))
	130	(reg-B (ediff-get-region-contents n 'B ediff-control-buffer))
	131	(reg-C (ediff-get-region-contents n 'C ediff-control-buffer)))
	132
13340e24 KH	133	;;; was edited since first set by default
13340e24 KH	134	(if (or (and (string= state-of-merge "default-A")
475f9031	135	(not (string= reg-A reg-C)))
13340e24 KH	136	;; was edited since first set by default
	137	(and (string= state-of-merge "default-B")
	138	(not (string= reg-B reg-C)))
	139	;; was edited since first set by default
	140	(and (string= state-of-merge "combined")
	141	(not (string=
	142	(ediff-make-combined-diff reg-A reg-B) reg-C)))
a7acbbe4	143	;; was preferred--ignore
13340e24	144	(string-match "prefer" state-of-merge))
475f9031 KH	145	(setq do-not-copy t))
	146
	147	;; change state of merge for this diff, if necessary
13340e24 KH	148	(if (and (string-match "\\(default\\\|combined\\)" state-of-merge)
13340e24 KH	149	(not do-not-copy))
475f9031 KH	150	(ediff-set-state-of-merge
	151	n (format "%S" ediff-default-variant)))
	152	))
	153
	154	;; state-of-merge may have changed via ediff-set-state-of-merge, so
13340e24	155	;; check it once again
475f9031 KH	156	(setq state-of-merge (ediff-get-state-of-merge n))
	157
	158	(or do-not-copy
	159	(if (string= state-of-merge "combined")
	160	;; use n+1 because ediff-combine-diffs works via user numbering
	161	;; of diffs, which is 1+ to what ediff uses internally
	162	(ediff-combine-diffs (1+ n) 'batch)
13340e24 KH	163	(ediff-copy-diff
13340e24 KH	164	n (if (string-match "-A" state-of-merge) 'A 'B) 'C 'batch)))
475f9031 KH	165	(setq n (1+ n)))
	166	(message "Merging buffers A & B into C ... Done")
	167	))
	168
	169
	170	(defun ediff-re-merge ()
	171	"Remerge unmodified diff regions using a new default. Start with the current region."
	172	(interactive)
	173	(let* ((default-variant-alist
	174	(list '("default-A") '("default-B") '("combined")))
	175	(actual-alist
	176	(delete (list (symbol-name ediff-default-variant))
	177	default-variant-alist)))
	178	(setq ediff-default-variant
	179	(intern
	180	(completing-read
	181	(format "Current merge default is `%S'. New default: "
	182	ediff-default-variant)
	183	actual-alist nil 'must-match)))
	184	(ediff-do-merge ediff-current-difference 'remerge)
	185	(ediff-recenter)
	186	))
	187
	188	(defun ediff-shrink-window-C (arg)
	189	"Shrink window C to just one line.
	190	With a prefix argument, returns window C to its normal size.
	191	Used only for merging jobs."
	192	(interactive "P")
	193	(if (not ediff-merge-job)
	194	(error "ediff-shrink-window-C can be used only for merging jobs"))
	195	(cond ((eq arg '-) (setq arg -1))
	196	((not (numberp arg)) (setq arg nil)))
	197	(cond ((null arg)
	198	(let ((ediff-merge-window-share
	199	(if (< (window-height ediff-window-C) 3)
	200	ediff-merge-window-share 0)))
	201	(setq ediff-window-config-saved "") ; force redisplay
	202	(ediff-recenter 'no-rehighlight)))
	203	((and (< arg 0) (> (window-height ediff-window-C) 2))
	204	(setq ediff-merge-window-share (* ediff-merge-window-share 0.9))
	205	(setq ediff-window-config-saved "") ; force redisplay
	206	(ediff-recenter 'no-rehighlight))
	207	((and (> arg 0) (> (window-height ediff-window-A) 2))
	208	(setq ediff-merge-window-share (* ediff-merge-window-share 1.1))
	209	(setq ediff-window-config-saved "") ; force redisplay
	210	(ediff-recenter 'no-rehighlight))))
	211
	212
	213	;; N here is the user's region number. It is 1+ what Ediff uses internally.
	214	(defun ediff-combine-diffs (n &optional batch-invocation)
	215	"Combine Nth diff regions of buffers A and B and place the combination in C.
	216	Combining is done using the list in variable `ediff-combination-pattern'."
	217	(interactive "P")
	218	(setq n (if n (1- n) ediff-current-difference))
	219
	220	(let (regA regB reg-combined)
	221	(setq regA (ediff-get-region-contents n 'A ediff-control-buffer)
	222	regB (ediff-get-region-contents n 'B ediff-control-buffer))
	223
13340e24	224	(setq reg-combined (ediff-make-combined-diff regA regB))
475f9031 KH	225
475f9031 KH	226	(ediff-copy-diff n nil 'C batch-invocation reg-combined))
13340e24	227	(or batch-invocation (ediff-recenter)))
475f9031	228
475f9031 KH	229
	230	;; Checks if the region in buff C looks like a combination of the regions
	231	;; in buffers A and B. Returns a list (reg-a-beg reg-a-end reg-b-beg reg-b-end)
	232	;; These refer to where the copies of region A and B start and end in buffer C
	233	(defun ediff-looks-like-combined-merge (region-num)
	234	(if ediff-merge-job
	235	(let ((combined (string-match (regexp-quote "(A+B)")
	236	(or (ediff-get-state-of-diff region-num 'C)
	237	"")))
	238	(reg-beg (ediff-get-diff-posn 'C 'beg region-num))
	239	(reg-end (ediff-get-diff-posn 'C 'end region-num))
	240	(pat1 (nth 0 ediff-combination-pattern))
	241	(pat2 (nth 1 ediff-combination-pattern))
	242	(pat3 (nth 2 ediff-combination-pattern))
	243	reg-a-beg reg-a-end reg-b-beg reg-b-end reg-c-beg reg-c-end)
	244
	245	(if combined
	246	(ediff-eval-in-buffer ediff-buffer-C
	247	(goto-char reg-beg)
	248	(search-forward pat1 reg-end 'noerror)
	249	(setq reg-a-beg (match-beginning 0))
	250	(setq reg-a-end (match-end 0))
	251	(search-forward pat2 reg-end 'noerror)
	252	(setq reg-b-beg (match-beginning 0))
	253	(setq reg-b-end (match-end 0))
	254	(search-forward pat3 reg-end 'noerror)
	255	(setq reg-c-beg (match-beginning 0))
	256	(setq reg-c-end (match-end 0))))
	257
	258	(if (and reg-a-beg reg-a-end reg-b-beg reg-b-end)
	259	(list reg-a-beg reg-a-end reg-b-beg reg-b-end reg-c-beg reg-c-end))
	260	)))
	261
	262
	263	(provide 'ediff-merg)
	264
	265	;; ediff-merg.el ends here