ediff-ptch.el 26.1 KB
Newer Older
Michael Kifer's avatar
Michael Kifer committed
1 2
;;; ediff-ptch.el --- Ediff's  patch support

Michael Kifer's avatar
Michael Kifer committed
3
;; Copyright (C) 1996, 1997 Free Software Foundation, Inc.
Michael Kifer's avatar
Michael Kifer committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

;; 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:
Michael Kifer's avatar
Michael Kifer committed
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
	 
(provide 'ediff-ptch)

(defgroup ediff-ptch nil
  "Ediff patch support"
  :tag "Patch"
  :prefix "ediff-"
  :group 'ediff)

;; compiler pacifier
(defvar ediff-window-A)
(defvar ediff-window-B)
(defvar ediff-window-C)
(defvar ediff-use-last-dir)
(defvar ediff-shell)

(eval-when-compile
  (let ((load-path (cons (expand-file-name ".") load-path)))
    (or (featurep 'ediff-init)
	(load "ediff-init.el" nil nil 'nosuffix))
    (or (featurep 'ediff)
	(load "ediff.el" nil nil 'nosuffix))
    ))
;; end pacifier
Michael Kifer's avatar
Michael Kifer committed
50

Richard M. Stallman's avatar
Richard M. Stallman committed
51 52
(require 'ediff-init)

Michael Kifer's avatar
Michael Kifer committed
53 54 55 56 57 58 59 60 61 62 63
(defcustom ediff-patch-program  "patch"
  "*Name of the program that applies patches.
It is recommended to use GNU-compatible versions."
  :type 'string
  :group 'ediff-ptch)
(defcustom ediff-patch-options "-f"
  "*Options to pass to ediff-patch-program.

Note: the `-b' option should be specified in `ediff-backup-specs'.

It is recommended to pass the `-f' option to the patch program, so it won't ask
Michael Kifer's avatar
Michael Kifer committed
64
questions.  However, some implementations don't accept this option, in which
Michael Kifer's avatar
Michael Kifer committed
65 66 67 68
case the default value for this variable should be changed."
  :type 'string
  :group 'ediff-ptch)

Michael Kifer's avatar
Michael Kifer committed
69 70 71
(defvar ediff-last-dir-patch nil
  "Last directory used by an Ediff command for file to patch.")

Michael Kifer's avatar
Michael Kifer committed
72 73 74 75 76 77 78
;; the default backup extension
(defconst ediff-default-backup-extension
  (if (memq system-type '(vax-vms axp-vms emx ms-dos))
      "_orig" ".orig"))
  

(defcustom ediff-backup-extension ediff-default-backup-extension
Michael Kifer's avatar
Michael Kifer committed
79
  "Backup extension used by the patch program.
Michael Kifer's avatar
Michael Kifer committed
80 81 82
See also `ediff-backup-specs'."
  :type 'string
  :group 'ediff-ptch)
Michael Kifer's avatar
Michael Kifer committed
83

Michael Kifer's avatar
Michael Kifer committed
84 85 86 87 88 89 90 91
(defun ediff-test-patch-utility ()
  (cond ((zerop (call-process ediff-patch-program nil nil nil "-z." "-b"))
	 ;; GNU `patch' v. >= 2.2
	 'gnu)
	((zerop (call-process ediff-patch-program nil nil nil "-b"))
	 'posix)
	(t 'traditional)))

Michael Kifer's avatar
Michael Kifer committed
92
(defcustom ediff-backup-specs 
Michael Kifer's avatar
Michael Kifer committed
93 94 95 96 97 98 99 100 101 102 103
  (let ((type (ediff-test-patch-utility)))
    (cond ((eq type 'gnu)
	   ;; GNU `patch' v. >= 2.2
	   (format "-z%s -b" ediff-backup-extension))
	  ((eq type 'posix)
	   ;; POSIX `patch' -- ediff-backup-extension must be ".orig"
	   (setq ediff-backup-extension ediff-default-backup-extension)
	   "-b")
	  (t
	   ;; traditional `patch'
	   (format "-b %s" ediff-backup-extension))))
Michael Kifer's avatar
Michael Kifer committed
104 105
  "*Backup directives to pass to the patch program.
Ediff requires that the old version of the file \(before applying the patch\)
Michael Kifer's avatar
Michael Kifer committed
106
be saved in a file named `the-patch-file.extension'.  Usually `extension' is
Michael Kifer's avatar
Michael Kifer committed
107 108 109 110
`.orig', but this can be changed by the user and may depend on the system.
Therefore, Ediff needs to know the backup extension used by the patch program.

Some versions of the patch program let you specify `-b backup-extension'.
Michael Kifer's avatar
Michael Kifer committed
111
Other versions only permit `-b', which assumes the extension `.orig'
Michael Kifer's avatar
Michael Kifer committed
112
\(in which case ediff-backup-extension MUST be also `.orig'\).  The latest
Michael Kifer's avatar
Michael Kifer committed
113
versions of GNU patch require `-b -z backup-extension'.
Michael Kifer's avatar
Michael Kifer committed
114 115

Note that both `ediff-backup-extension' and `ediff-backup-specs'
Michael Kifer's avatar
Michael Kifer committed
116
must be set properly.  If your patch program takes the option `-b',
Michael Kifer's avatar
Michael Kifer committed
117
but not `-b extension', the variable `ediff-backup-extension' must
Michael Kifer's avatar
Michael Kifer committed
118 119
still be set so Ediff will know which extension to use.

Michael Kifer's avatar
Michael Kifer committed
120
Ediff tries to guess the appropriate value for this variables.  It is believed
Michael Kifer's avatar
Michael Kifer committed
121
to be working for `traditional' patch, all versions of GNU patch, and for POSIX
Michael Kifer's avatar
Michael Kifer committed
122
patch.  So, don't change these variables, unless the default doesn't work."
Michael Kifer's avatar
Michael Kifer committed
123 124
  :type 'string
  :group 'ediff-ptch)
Michael Kifer's avatar
Michael Kifer committed
125

Michael Kifer's avatar
Michael Kifer committed
126

Michael Kifer's avatar
Michael Kifer committed
127 128 129 130
(defcustom ediff-patch-default-directory nil
  "*Default directory to look for patches."
  :type '(choice (const nil) string)
  :group 'ediff-ptch)
Michael Kifer's avatar
Michael Kifer committed
131

Michael Kifer's avatar
Michael Kifer committed
132
(defcustom ediff-context-diff-label-regexp
Michael Kifer's avatar
Michael Kifer committed
133 134 135
  (concat "\\(" 	; context diff 2-liner
	  "^\\*\\*\\* \\([^ \t]+\\)[^*]+[\t ]*\n--- \\([^ \t]+\\)"
	  "\\|" 	; GNU unified format diff 2-liner
136
	  "^--- \\([^ \t]+\\)[\t ]+.*\n\\+\\+\\+ \\([^ \t]+\\)"
Michael Kifer's avatar
Michael Kifer committed
137
	  "\\)")
Michael Kifer's avatar
Michael Kifer committed
138 139 140
  "*Regexp matching filename 2-liners at the start of each context diff.
You probably don't want to change that, unless you are using an obscure patch
program."
Michael Kifer's avatar
Michael Kifer committed
141 142
  :type 'regexp
  :group 'ediff-ptch)
Michael Kifer's avatar
Michael Kifer committed
143

Michael Kifer's avatar
Michael Kifer committed
144
;; The buffer of the patch file.  Local to control buffer.
Michael Kifer's avatar
Michael Kifer committed
145 146 147 148 149
(ediff-defvar-local ediff-patchbufer nil "")

;; The buffer where patch displays its diagnostics.
(ediff-defvar-local ediff-patch-diagnostics nil "")

Michael Kifer's avatar
Michael Kifer committed
150
;; Map of patch buffer.  Has the form:
Michael Kifer's avatar
Michael Kifer committed
151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
;;    ((filename1 marker1 marker2) (filename2 marker1 marker2) ...)
;; where filenames are files to which patch would have applied the patch;
;; marker1 delimits the beginning of the corresponding patch and marker2 does
;; it for the end.
(ediff-defvar-local ediff-patch-map nil "")

;; strip prefix from filename
;; returns /dev/null, if can't strip prefix
(defsubst ediff-file-name-sans-prefix (filename prefix)
  (save-match-data
    (if (string-match (concat "^" prefix) filename)
	(substring filename (match-end 0))
      (concat "/null/" filename))))



;; no longer used
;; return the number of matches of regexp in buf starting from the beginning
(defun ediff-count-matches (regexp buf)
Michael Kifer's avatar
Michael Kifer committed
170
  (ediff-with-current-buffer buf
Michael Kifer's avatar
Michael Kifer committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
    (let ((count 0) opoint)
      (save-excursion
	(goto-char (point-min))
	(while (and (not (eobp))
		    (progn (setq opoint (point))
			   (re-search-forward regexp nil t)))
	  (if (= opoint (point))
	      (forward-char 1)
	    (setq count (1+ count)))))
      count)))

;; Scan BUF (which is supposed to contain a patch) and make a list of the form 
;;    ((filename1 marker1 marker2) (filename2 marker1 marker2) ...)
;; where filenames are files to which patch would have applied the patch;
;; marker1 delimits the beginning of the corresponding patch and marker2 does
Michael Kifer's avatar
Michael Kifer committed
186
;; it for the end.  This list is then assigned to ediff-patch-map.
Michael Kifer's avatar
Michael Kifer committed
187 188
;; Returns the number of elements in the list ediff-patch-map
(defun ediff-map-patch-buffer (buf)
Michael Kifer's avatar
Michael Kifer committed
189
  (ediff-with-current-buffer buf
Michael Kifer's avatar
Michael Kifer committed
190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205
    (let ((count 0)
	  (mark1 (move-marker (make-marker) (point-min)))
	  (mark1-end (point-min))
	  (possible-file-names '("/dev/null" . "/dev/null"))
	  mark2-end mark2 filenames
	  beg1 beg2 end1 end2
	  patch-map opoint)
      (save-excursion
	(goto-char (point-min))
	(setq opoint (point))
	(while (and (not (eobp))
		    (re-search-forward ediff-context-diff-label-regexp nil t))
	  (if (= opoint (point))
	      (forward-char 1) ; ensure progress towards the end
	    (setq mark2 (move-marker (make-marker) (match-beginning 0))
		  mark2-end (match-end 0)
206
		  beg1 (or (match-beginning 2) (match-beginning 4))
Michael Kifer's avatar
Michael Kifer committed
207 208 209
 		  end1 (or (match-end 2) (match-end 4))
 		  beg2 (or (match-beginning 3) (match-beginning 5))
 		  end2 (or (match-end 3) (match-end 5)))
Michael Kifer's avatar
Michael Kifer committed
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
	    ;; possible-file-names is holding the new file names until we
	    ;; insert the old file name in the patch map
	    ;; It is a pair (filename from 1st header line . fn from 2nd line)
	    (setq possible-file-names
		  (cons (if (and beg1 end1)
			    (buffer-substring beg1 end1)
			  "/dev/null")
			(if (and beg2 end2)
			    (buffer-substring beg2 end2)
			  "/dev/null")))
	    ;; check for any `Index:' or `Prereq:' lines, but don't use them
	    (if (re-search-backward "^Index:" mark1-end 'noerror)
		(move-marker mark2 (match-beginning 0)))
	    (if (re-search-backward "^Prereq:" mark1-end 'noerror)
		(move-marker mark2 (match-beginning 0)))

	    (goto-char mark2-end)
	    
	    (if filenames
		(setq patch-map (cons (list filenames mark1 mark2) patch-map)))
	    (setq mark1 mark2
		  mark1-end mark2-end
		  filenames possible-file-names))
	  (setq opoint (point)
		count (1+ count))))
      (setq mark2 (point-max-marker)
	    patch-map (cons (list possible-file-names mark1 mark2) patch-map))
      (setq ediff-patch-map (nreverse patch-map))
      count)))

;; Fix up the file names in the list using the argument FILENAME
;; Algorithm: find the first file's directory and cut it out from each file
Michael Kifer's avatar
Michael Kifer committed
242 243
;; name in the patch.  Prepend the directory of FILENAME to each file in the
;; patch.  In addition, the first file in the patch is replaced by FILENAME.
Michael Kifer's avatar
Michael Kifer committed
244 245 246
;; Each file is actually a file-pair of files found in the context diff header
;; In the end, for each pair, we select the shortest existing file.
;; Note: Ediff doesn't recognize multi-file patches that are separated
Michael Kifer's avatar
Michael Kifer committed
247
;; with the `Index:' line.  It treats them as a single-file patch.
Michael Kifer's avatar
Michael Kifer committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261
;;
;; Executes inside the patch buffer
(defun ediff-fixup-patch-map (filename)
  (setq filename (expand-file-name filename))
  (let ((actual-dir (if (file-directory-p filename)
			;; directory part of filename
			(file-name-as-directory filename)
		      (file-name-directory filename)))
	;; directory part of the first file in the patch
	(base-dir1 (file-name-directory (car (car (car ediff-patch-map)))))
	(base-dir2 (file-name-directory (cdr (car (car ediff-patch-map)))))
	)

    ;; chop off base-dirs
Michael Kifer's avatar
Michael Kifer committed
262 263 264 265 266 267 268 269 270 271
    (mapcar (lambda (triple)
	      (or (string= (car (car triple)) "/dev/null")
		  (setcar (car triple)
			  (ediff-file-name-sans-prefix
			   (car (car triple)) base-dir1)))
	      (or (string= (cdr (car triple)) "/dev/null")
		  (setcdr (car triple)
			  (ediff-file-name-sans-prefix
			   (cdr (car triple)) base-dir2)))
	      )
Michael Kifer's avatar
Michael Kifer committed
272 273 274 275 276 277 278 279 280 281 282
	    ediff-patch-map)

    ;; take the given file name into account
    (or (file-directory-p filename)
	(string= "/dev/null" filename)
	(progn
	  (setcar (car ediff-patch-map)
		  (cons (file-name-nondirectory filename)
			(file-name-nondirectory filename)))))

    ;; prepend actual-dir
Michael Kifer's avatar
Michael Kifer committed
283 284 285 286 287 288 289 290 291
    (mapcar (lambda (triple)
	      (if (and (string-match "^/null/" (car (car triple)))
		       (string-match "^/null/" (cdr (car triple))))
		  ;; couldn't strip base-dir1 and base-dir2
		  ;; hence, something wrong
		  (progn
		    (with-output-to-temp-buffer ediff-msg-buffer
		      (princ
		       (format "
Michael Kifer's avatar
Michael Kifer committed
292 293 294 295
The patch file contains a context diff for
	%s
	%s
However, Ediff cannot infer the name of the actual file
Michael Kifer's avatar
Michael Kifer committed
296
to be patched on your system.  If you know the correct file name,
Michael Kifer's avatar
Michael Kifer committed
297 298 299 300 301
please enter it now.

If you don't know and still would like to apply patches to
other files, enter /dev/null
"
Michael Kifer's avatar
Michael Kifer committed
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
			       (substring (car (car triple)) 6)
			       (substring (cdr (car triple)) 6))))
		    (let ((directory t)
			  user-file)
		      (while directory
			(setq user-file
			      (read-file-name
			       "Please enter file name: "
			       actual-dir actual-dir t))
			(if (not (file-directory-p user-file))
			    (setq directory nil)
			  (setq directory t)
			  (beep)
			  (message "%s is a directory" user-file)
			  (sit-for 2)))
		      (setcar triple (cons user-file user-file))))
		(setcar (car triple)
			(expand-file-name 
			 (concat actual-dir (car (car triple)))))
		(setcdr (car triple)
			(expand-file-name 
			 (concat actual-dir (cdr (car triple))))))
	      )
Michael Kifer's avatar
Michael Kifer committed
325 326 327
	    ediff-patch-map)
    ;; check for the shorter existing file in each pair and discard the other
    ;; one
Michael Kifer's avatar
Michael Kifer committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
    (mapcar (lambda (triple)
	      (let* ((file1 (car (car triple)))
		     (file2 (cdr (car triple)))
		     (f1-exists (file-exists-p file1))
		     (f2-exists (file-exists-p file2)))
		(cond
		 ((and (< (length file2) (length file1))
		       f2-exists)
		  (setcar triple file2))
		 ((and (< (length file1) (length file2))
		       f1-exists)
		  (setcar triple file1))
		 ((and f1-exists f2-exists
		       (string= file1 file2))
		  (setcar triple file1))
		 ((and f1-exists f2-exists)
		  (with-output-to-temp-buffer ediff-msg-buffer
		    (princ (format "
Michael Kifer's avatar
Michael Kifer committed
346 347 348
Ediff has inferred that
	%s
	%s
Michael Kifer's avatar
Michael Kifer committed
349
are two possible targets for applying the patch.
Michael Kifer's avatar
Michael Kifer committed
350 351 352 353 354 355
Both files seem to be plausible alternatives.

Please advice:
    Type `y' to use %s as the target;
    Type `n' to use %s as the target.
"
Michael Kifer's avatar
Michael Kifer committed
356 357 358 359 360 361 362 363 364 365 366
				   file1 file2 file2 file1)))
		  (setcar triple
			  (if (y-or-n-p (format "Use %s ? " file2))
			      file2 file1)))
		 (f2-exists (setcar triple file2))
		 (f1-exists (setcar triple file1))
		 (t
		  (with-output-to-temp-buffer ediff-msg-buffer
		    (princ "\nEdiff has inferred that")
		    (if (string= file1 file2)
			(princ (format "
Michael Kifer's avatar
Michael Kifer committed
367
	%s
Michael Kifer's avatar
Michael Kifer committed
368 369 370
is the target for this patch.  However, this file does not exist."
				       file1))
		      (princ (format "
Michael Kifer's avatar
Michael Kifer committed
371
	%s
Michael Kifer's avatar
Michael Kifer committed
372
	%s
Michael Kifer's avatar
Michael Kifer committed
373 374 375
are two possible targets for this patch.  However, these files do not exist."
				     file1 file2)))
		    (princ "
Michael Kifer's avatar
Michael Kifer committed
376
\nPlease enter an alternative patch target ...\n"))
Michael Kifer's avatar
Michael Kifer committed
377 378 379 380 381 382 383 384 385 386 387 388
		  (let ((directory t)
			target)
		    (while directory
		      (setq target (read-file-name 
				    "Please enter a patch target: "
				    actual-dir actual-dir t))
		      (if (not (file-directory-p target))
			  (setq directory nil)
			(beep)
			(message "%s is a directory" target)
			(sit-for 2)))
		    (setcar triple target))))))
Michael Kifer's avatar
Michael Kifer committed
389 390 391 392 393 394 395 396 397 398 399
	    ediff-patch-map)
    ))

(defun ediff-show-patch-diagnostics ()
  (interactive)
  (cond ((window-live-p ediff-window-A)
	 (set-window-buffer ediff-window-A ediff-patch-diagnostics))
	((window-live-p ediff-window-B)
	 (set-window-buffer ediff-window-B ediff-patch-diagnostics))
	(t (display-buffer ediff-patch-diagnostics 'not-this-window))))

Michael Kifer's avatar
Michael Kifer committed
400 401
;; prompt for file, get the buffer
(defun ediff-prompt-for-patch-file ()
Michael Kifer's avatar
Michael Kifer committed
402 403
  (let ((dir (cond (ediff-patch-default-directory) ; try patch default dir
		   (ediff-use-last-dir ediff-last-dir-patch)
Michael Kifer's avatar
Michael Kifer committed
404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462
		   (t default-directory))))
    (find-file-noselect
     (read-file-name
      (format "Patch is in file:%s "
	      (cond ((and buffer-file-name
			  (equal (expand-file-name dir)
				 (file-name-directory buffer-file-name)))
		     (concat
		      " (default "
		      (file-name-nondirectory buffer-file-name)
		      ")"))
		    (t "")))
      dir buffer-file-name 'must-match))
    ))


;; Try current buffer, then the other window's buffer. Else, give up.
(defun ediff-prompt-for-patch-buffer ()
  (get-buffer
   (read-buffer
    "Patch is in buffer: "
    (cond ((save-excursion
	     (goto-char (point-min))
	     (re-search-forward ediff-context-diff-label-regexp nil t))
	   (current-buffer))
	  ((save-window-excursion
	     (other-window 1)
	     (save-excursion
	       (goto-char (point-min))
	       (and (re-search-forward ediff-context-diff-label-regexp nil t)
		    (current-buffer)))))
	  ((save-window-excursion
	     (other-window -1)
	     (save-excursion
	       (goto-char (point-min))
	       (and (re-search-forward ediff-context-diff-label-regexp nil t)
		    (current-buffer)))))
	  (t nil))
    'must-match)))


(defun ediff-get-patch-buffer (&optional arg patch-buf)
  "Obtain patch buffer.  If patch is already in a buffer---use it.
Else, read patch file into a new buffer. If patch buffer is passed as an
optional argument, then use it."
  (let ((last-nonmenu-event t) ; Emacs: don't use dialog box
	last-command-event)    ; XEmacs: don't use dialog box

    (cond ((ediff-buffer-live-p patch-buf))
	  ;; even prefix arg: patch in buffer
	  ((and (integerp arg) (eq 0 (mod arg 2)))
	   (setq patch-buf (ediff-prompt-for-patch-buffer)))
	  ;; odd prefix arg: get patch from a file
	  ((and (integerp arg) (eq 1 (mod arg 2)))
	   (setq patch-buf (ediff-prompt-for-patch-file)))
	  (t (setq patch-buf
		   (if (y-or-n-p "Is the patch already in a buffer? ")
		       (ediff-prompt-for-patch-buffer)
		     (ediff-prompt-for-patch-file)))))
Michael Kifer's avatar
Michael Kifer committed
463
    
Michael Kifer's avatar
Michael Kifer committed
464
    (ediff-with-current-buffer patch-buf
Michael Kifer's avatar
Michael Kifer committed
465 466 467 468 469 470 471 472 473 474 475 476 477 478
      (goto-char (point-min))
      (or (ediff-get-visible-buffer-window patch-buf)
	  (progn
	    (pop-to-buffer patch-buf 'other-window)
	    (select-window (previous-window)))))
    (ediff-map-patch-buffer patch-buf)
    patch-buf))

;; Dispatch the right patch file function: regular or meta-level,
;; depending on how many patches are in the patch file.
;; At present, there is no support for meta-level patches.
;; Should return either the ctl buffer or the meta-buffer
(defun ediff-dispatch-file-patching-job (patch-buf filename
						   &optional startup-hooks)
Michael Kifer's avatar
Michael Kifer committed
479
  (ediff-with-current-buffer patch-buf
Michael Kifer's avatar
Michael Kifer committed
480 481 482 483 484 485 486 487 488 489 490 491 492 493
    ;; relativize names in the patch with respect to source-file
    (ediff-fixup-patch-map filename)
    (if (< (length ediff-patch-map) 2)
	(ediff-patch-file-internal
	 patch-buf
	 (if (and (not (string-match "^/dev/null" (car (car ediff-patch-map))))
		  (> (length (car (car ediff-patch-map))) 1))
	     (car (car ediff-patch-map))
	   filename)
	 startup-hooks)
      (ediff-multi-patch-internal patch-buf startup-hooks))
    ))


Michael Kifer's avatar
Michael Kifer committed
494
;; When patching a buffer, never change the orig file.  Instead, create a new
Michael Kifer's avatar
Michael Kifer committed
495 496 497 498 499 500
;; buffer, ***_patched, even if the buff visits a file.
;; Users who want to actually patch the buffer should use
;; ediff-patch-file, not ediff-patch-buffer.
(defun ediff-patch-buffer-internal (patch-buf
				    buf-to-patch-name
				    &optional startup-hooks)
Michael Kifer's avatar
Michael Kifer committed
501
  (let* ((buf-to-patch (get-buffer buf-to-patch-name))
Michael Kifer's avatar
Michael Kifer committed
502
	 (visited-file (if buf-to-patch (buffer-file-name  buf-to-patch)))
Michael Kifer's avatar
Michael Kifer committed
503
	 (buf-mod-status (buffer-modified-p buf-to-patch))
Michael Kifer's avatar
Michael Kifer committed
504
	 (multifile-patch-p (> (length (ediff-with-current-buffer patch-buf
Michael Kifer's avatar
Michael Kifer committed
505 506
					 ediff-patch-map)) 1))
	 default-dir file-name ctl-buf)
Michael Kifer's avatar
Michael Kifer committed
507 508
    (if multifile-patch-p
	(error
Michael Kifer's avatar
Michael Kifer committed
509
	 "To apply multi-file patches, please use `ediff-patch-file'"))
Michael Kifer's avatar
Michael Kifer committed
510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526

    ;; create a temp file to patch
    (ediff-with-current-buffer buf-to-patch
      (setq default-dir default-directory)
      (setq file-name (ediff-make-temp-file buf-to-patch))
      ;; temporarily switch visited file name, if any
      (set-visited-file-name file-name)
      ;; don't create auto-save file, if buff was visiting a file
      (or visited-file
	  (setq buffer-auto-save-file-name nil))
      ;; don't confuse the user with a new bufname
      (rename-buffer buf-to-patch-name)
      (set-buffer-modified-p nil)
      (set-visited-file-modtime) ; sync buffer and temp file
      (setq default-directory default-dir)
      )
  
Michael Kifer's avatar
Michael Kifer committed
527 528 529 530
    ;; dispatch a patch function
    (setq ctl-buf (ediff-dispatch-file-patching-job
		   patch-buf file-name startup-hooks))
    
Michael Kifer's avatar
Michael Kifer committed
531 532 533 534 535 536 537 538 539 540 541 542 543 544 545
    (ediff-with-current-buffer ctl-buf
      (delete-file (buffer-file-name ediff-buffer-A))
      (delete-file (buffer-file-name ediff-buffer-B))
      (ediff-with-current-buffer ediff-buffer-A
	(if default-dir (setq default-directory default-dir))
	(set-visited-file-name visited-file) ; visited-file might be nil
	(rename-buffer buf-to-patch-name)
	(set-buffer-modified-p buf-mod-status))
      (ediff-with-current-buffer ediff-buffer-B
	(setq buffer-auto-save-file-name nil) ; don't create auto-save file
	(if default-dir (setq default-directory default-dir))
	(set-visited-file-name nil)
	(rename-buffer (ediff-unique-buffer-name 
			(concat buf-to-patch-name "_patched") ""))
	(set-buffer-modified-p t)))
Michael Kifer's avatar
Michael Kifer committed
546 547
    ))

Michael Kifer's avatar
Michael Kifer committed
548 549 550 551 552 553 554 555 556 557 558

;; Traditional patch has weird return codes.
;; GNU and Posix return 1 if some hanks failed and 2 in case of trouble.
;; 0 is a good code in all cases.
;; We'll do the concervative thing.
(defun ediff-patch-return-code-ok (code)
  (eq code 0))
;;;  (if (eq (ediff-test-patch-utility) 'traditional)
;;;      (eq code 0)
;;;    (not (eq code 2))))

Michael Kifer's avatar
Michael Kifer committed
559 560 561 562
(defun ediff-patch-file-internal (patch-buf source-filename
					    &optional startup-hooks)
  (setq source-filename (expand-file-name source-filename))
  
Michael Kifer's avatar
Michael Kifer committed
563
  (let* ((shell-file-name ediff-shell)
Michael Kifer's avatar
Michael Kifer committed
564 565 566 567 568 569 570
	 (patch-diagnostics (get-buffer-create "*ediff patch diagnostics*"))
	 ;; ediff-find-file may use a temp file to do the patch
	 ;; so, we save source-filename and true-source-filename as a var
	 ;; that initially is source-filename but may be changed to a temp
	 ;; file for the purpose of patching.
	 (true-source-filename source-filename)
	 (target-filename source-filename)
Michael Kifer's avatar
Michael Kifer committed
571
	 target-buf buf-to-patch file-name-magic-p 
Michael Kifer's avatar
Michael Kifer committed
572
	 patch-return-code ctl-buf backup-style aux-wind)
Michael Kifer's avatar
Michael Kifer committed
573
	  
Michael Kifer's avatar
Michael Kifer committed
574
    (if (string-match "V" ediff-patch-options)
Michael Kifer's avatar
Michael Kifer committed
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
	(error
	 "Ediff doesn't take the -V option in `ediff-patch-options'--sorry"))
					
    ;; Make a temp file, if source-filename has a magic file handler (or if
    ;; it is handled via auto-mode-alist and similar magic).
    ;; Check if there is a buffer visiting source-filename and if they are in
    ;; sync; arrange for the deletion of temp file.
    (ediff-find-file 'true-source-filename 'buf-to-patch
		     'ediff-last-dir-patch 'startup-hooks)

    ;; Check if source file name has triggered black magic, such as file name
    ;; handlers or auto mode alist, and make a note of it.
    ;; true-source-filename should be either the original name or a
    ;; temporary file where we put the after-product of the file handler.
    (setq file-name-magic-p (not (equal (file-truename true-source-filename)
					(file-truename source-filename))))
    
Michael Kifer's avatar
Michael Kifer committed
592 593 594
    ;; Checkout orig file, if necessary, so that the patched file 
    ;; could be checked back in.
    (ediff-maybe-checkout buf-to-patch)
Michael Kifer's avatar
Michael Kifer committed
595

Michael Kifer's avatar
Michael Kifer committed
596
    (ediff-with-current-buffer patch-diagnostics
Michael Kifer's avatar
Michael Kifer committed
597 598 599 600 601
      (insert-buffer patch-buf)
      (message "Applying patch ... ")
      ;; fix environment for gnu patch, so it won't make numbered extensions
      (setq backup-style (getenv "VERSION_CONTROL"))
      (setenv "VERSION_CONTROL" nil)
Michael Kifer's avatar
Michael Kifer committed
602 603 604 605 606 607 608 609 610 611 612 613 614 615 616
      (setq patch-return-code
	    (call-process-region
	     (point-min) (point-max)
	     shell-file-name
	     t   ; delete region (which contains the patch
	     t   ; insert output (patch diagnostics) in current buffer
	     nil ; don't redisplay
	     shell-command-switch   ; usually -c
	     (format "%s %s %s %s"
		     ediff-patch-program
		     ediff-patch-options
		     ediff-backup-specs
		     (expand-file-name true-source-filename))
	     ))

Michael Kifer's avatar
Michael Kifer committed
617 618 619 620 621 622 623 624 625
      ;; restore environment for gnu patch
      (setenv "VERSION_CONTROL" backup-style))

    (message "Applying patch ... done")
    (message "")

    (switch-to-buffer patch-diagnostics)
    (sit-for 0) ; synchronize - let the user see diagnostics
    
Michael Kifer's avatar
Michael Kifer committed
626
    (or (and (ediff-patch-return-code-ok patch-return-code)
Michael Kifer's avatar
Michael Kifer committed
627 628 629 630
	     (file-exists-p
	      (concat true-source-filename ediff-backup-extension)))
	(progn
	  (with-output-to-temp-buffer ediff-msg-buffer
Michael Kifer's avatar
Michael Kifer committed
631
	    (princ (format 
Michael Kifer's avatar
Michael Kifer committed
632 633 634
		    "Patch program has failed due to a bad patch file,
it couldn't apply all hunks, OR
it couldn't create the backup for the file being patched.
Michael Kifer's avatar
Michael Kifer committed
635

Michael Kifer's avatar
Michael Kifer committed
636 637
The former could be caused by a corrupt patch file or because the %S
program doesn't understand the format of the patch file in use.
Michael Kifer's avatar
Michael Kifer committed
638

Michael Kifer's avatar
Michael Kifer committed
639
The second problem might be due to an incompatibility among these settings:
Michael Kifer's avatar
Michael Kifer committed
640 641
    ediff-patch-program    = %S             ediff-patch-options    = %S
    ediff-backup-extension = %S             ediff-backup-specs     = %S
Michael Kifer's avatar
Michael Kifer committed
642 643

See Ediff on-line manual for more details on these variables.
Michael Kifer's avatar
Michael Kifer committed
644 645 646 647 648
In particular, check the documentation for `ediff-backup-specs'. 

In any of the above cases, Ediff doesn't compare files automatically.
However, if the patch was applied partially and the backup file was created,
you can still examine the changes via M-x ediff-files"
Michael Kifer's avatar
Michael Kifer committed
649 650
			   ediff-patch-program
			   ediff-patch-program
Michael Kifer's avatar
Michael Kifer committed
651 652 653
			   ediff-patch-options
			   ediff-backup-extension
			   ediff-backup-specs
Michael Kifer's avatar
Michael Kifer committed
654
			   )))
Michael Kifer's avatar
Michael Kifer committed
655 656 657 658 659
	  (beep 1)
	  (if (setq aux-wind (get-buffer-window ediff-msg-buffer))
	      (progn
		(select-window aux-wind)
		(goto-char (point-max))))
Michael Kifer's avatar
Michael Kifer committed
660
	  (switch-to-buffer-other-window patch-diagnostics)
Michael Kifer's avatar
Michael Kifer committed
661 662
	  (error "Patch appears to have failed")))
    
Michael Kifer's avatar
Michael Kifer committed
663
    ;; If black magic is involved, apply patch to a temp copy of the
Michael Kifer's avatar
Michael Kifer committed
664
    ;; file.  Otherwise, apply patch to the orig copy.  If patch is applied
Michael Kifer's avatar
Michael Kifer committed
665
    ;; to temp copy, we name the result old-name_patched for local files
Michael Kifer's avatar
Michael Kifer committed
666
    ;; and temp-copy_patched for remote files.  The orig file name isn't
Michael Kifer's avatar
Michael Kifer committed
667 668 669 670 671
    ;; changed, and the temp copy of the original is later deleted.
    ;; Without magic, the original file is renamed (usually into
    ;; old-name_orig) and the result of patching will have the same name as
    ;; the original.
    (if (not file-name-magic-p)
Michael Kifer's avatar
Michael Kifer committed
672
	(ediff-with-current-buffer buf-to-patch
Michael Kifer's avatar
Michael Kifer committed
673 674
	  (set-visited-file-name
	   (concat source-filename ediff-backup-extension))
Michael Kifer's avatar
Michael Kifer committed
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
	  (set-buffer-modified-p nil))
      
      ;; Black magic in effect.
      ;; If orig file was remote, put the patched file in the temp directory.
      ;; If orig file is local, put the patched file in the directory of
      ;; the orig file.
      (setq target-filename
	    (concat
	     (if (ediff-file-remote-p (file-truename source-filename))
		 true-source-filename
	       source-filename)
	     "_patched"))
      
      (rename-file true-source-filename target-filename t)
      
      ;; arrange that the temp copy of orig will be deleted
Michael Kifer's avatar
Michael Kifer committed
691
      (rename-file (concat true-source-filename ediff-backup-extension)
Michael Kifer's avatar
Michael Kifer committed
692 693 694 695 696 697 698 699 700 701 702 703 704
		   true-source-filename t))
    
    ;; make orig buffer read-only
    (setq startup-hooks
	  (cons 'ediff-set-read-only-in-buf-A startup-hooks))
    
    ;; set up a buf for the patched file
    (setq target-buf (find-file-noselect target-filename))
    
    (setq ctl-buf
	  (ediff-buffers-internal
	   buf-to-patch target-buf nil
	   startup-hooks 'epatch))
Michael Kifer's avatar
Michael Kifer committed
705
    (ediff-with-current-buffer ctl-buf
Michael Kifer's avatar
Michael Kifer committed
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
      (setq ediff-patchbufer patch-buf
	    ediff-patch-diagnostics patch-diagnostics))
  
    (bury-buffer patch-diagnostics)
    (message "Type `P', if you need to see patch diagnostics")
    ctl-buf))

(defun ediff-multi-patch-internal (patch-buf &optional startup-hooks)
  (let (meta-buf)
    (setq startup-hooks
	  ;; this sets various vars in the meta buffer inside
	  ;; ediff-prepare-meta-buffer
	  (cons (` (lambda ()
		     ;; tell what to do if the user clicks on a session record
		     (setq ediff-session-action-function
			   'ediff-patch-file-form-meta
			   ediff-meta-patchbufer patch-buf)
		     ))
		startup-hooks))
    (setq meta-buf (ediff-prepare-meta-buffer 
		    'ediff-filegroup-action
Michael Kifer's avatar
Michael Kifer committed
727
		    (ediff-with-current-buffer patch-buf
Michael Kifer's avatar
Michael Kifer committed
728 729 730 731 732 733 734 735 736 737 738 739 740 741 742
		      ;; nil replaces a regular expression
		      (cons (list nil (format "%S" patch-buf))
			    ediff-patch-map))
		    "*Ediff Session Group Panel"
		    'ediff-redraw-directory-group-buffer
		    'ediff-multifile-patch
		    startup-hooks))
    (ediff-show-meta-buffer meta-buf)
    ))

  
      

;;; Local Variables:
;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
Michael Kifer's avatar
Michael Kifer committed
743 744
;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
Michael Kifer's avatar
Michael Kifer committed
745 746 747
;;; End:

;;; ediff-ptch.el ends here