*** empty log message ***
[emacs.git] / lisp / ediff-ptch.el
blob342f75fd1e006bcc1a8a37005392ebaf12064b74
1 ;;; ediff-ptch.el --- Ediff's patch support
3 ;; Copyright (C) 1996, 97, 98, 99, 2000, 01, 02 Free Software Foundation, Inc.
5 ;; Author: Michael Kifer <kifer@cs.stonybrook.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)
12 ;; any later version.
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.
24 ;;; Commentary:
26 ;;; Code:
28 (provide 'ediff-ptch)
30 (defgroup ediff-ptch nil
31 "Ediff patch support"
32 :tag "Patch"
33 :prefix "ediff-"
34 :group 'ediff)
36 ;; compiler pacifier
37 (defvar ediff-window-A)
38 (defvar ediff-window-B)
39 (defvar ediff-window-C)
40 (defvar ediff-use-last-dir)
41 (defvar ediff-shell)
43 (eval-when-compile
44 (let ((load-path (cons (expand-file-name ".") load-path)))
45 (or (featurep 'ediff-init)
46 (load "ediff-init.el" nil nil 'nosuffix))
47 (or (featurep 'ediff-mult)
48 (load "ediff-mult.el" nil nil 'nosuffix))
49 (or (featurep 'ediff)
50 (load "ediff.el" nil nil 'nosuffix))
52 ;; end pacifier
54 (require 'ediff-init)
56 (defcustom ediff-patch-program "patch"
57 "*Name of the program that applies patches.
58 It is recommended to use GNU-compatible versions."
59 :type 'string
60 :group 'ediff-ptch)
61 (defcustom ediff-patch-options "-f"
62 "*Options to pass to ediff-patch-program.
64 Note: the `-b' option should be specified in `ediff-backup-specs'.
66 It is recommended to pass the `-f' option to the patch program, so it won't ask
67 questions. However, some implementations don't accept this option, in which
68 case the default value for this variable should be changed."
69 :type 'string
70 :group 'ediff-ptch)
72 (defvar ediff-last-dir-patch nil
73 "Last directory used by an Ediff command for file to patch.")
75 ;; the default backup extension
76 (defconst ediff-default-backup-extension
77 (if (memq system-type '(vax-vms axp-vms emx ms-dos))
78 "_orig" ".orig"))
81 (defcustom ediff-backup-extension ediff-default-backup-extension
82 "Backup extension used by the patch program.
83 See also `ediff-backup-specs'."
84 :type 'string
85 :group 'ediff-ptch)
87 (defun ediff-test-patch-utility ()
88 (condition-case nil
89 (cond ((eq 0 (call-process ediff-patch-program nil nil nil "-z." "-b"))
90 ;; GNU `patch' v. >= 2.2
91 'gnu)
92 ((eq 0 (call-process ediff-patch-program nil nil nil "-b"))
93 'posix)
94 (t 'traditional))
95 (file-error nil)))
97 (defcustom ediff-backup-specs
98 (let ((type (ediff-test-patch-utility)))
99 (cond ((eq type 'gnu)
100 ;; GNU `patch' v. >= 2.2
101 (format "-z%s -b" ediff-backup-extension))
102 ((eq type 'posix)
103 ;; POSIX `patch' -- ediff-backup-extension must be ".orig"
104 (setq ediff-backup-extension ediff-default-backup-extension)
105 "-b")
107 ;; traditional `patch'
108 (format "-b %s" ediff-backup-extension))))
109 "*Backup directives to pass to the patch program.
110 Ediff requires that the old version of the file \(before applying the patch\)
111 be saved in a file named `the-patch-file.extension'. Usually `extension' is
112 `.orig', but this can be changed by the user and may depend on the system.
113 Therefore, Ediff needs to know the backup extension used by the patch program.
115 Some versions of the patch program let you specify `-b backup-extension'.
116 Other versions only permit `-b', which assumes the extension `.orig'
117 \(in which case ediff-backup-extension MUST be also `.orig'\). The latest
118 versions of GNU patch require `-b -z backup-extension'.
120 Note that both `ediff-backup-extension' and `ediff-backup-specs'
121 must be set properly. If your patch program takes the option `-b',
122 but not `-b extension', the variable `ediff-backup-extension' must
123 still be set so Ediff will know which extension to use.
125 Ediff tries to guess the appropriate value for this variables. It is believed
126 to be working for `traditional' patch, all versions of GNU patch, and for POSIX
127 patch. So, don't change these variables, unless the default doesn't work."
128 :type 'string
129 :group 'ediff-ptch)
132 (defcustom ediff-patch-default-directory nil
133 "*Default directory to look for patches."
134 :type '(choice (const nil) string)
135 :group 'ediff-ptch)
137 (defcustom ediff-context-diff-label-regexp
138 (concat "\\(" ; context diff 2-liner
139 "^\\*\\*\\* \\([^ \t]+\\)[^*]+[\t ]*\n--- \\([^ \t]+\\)"
140 "\\|" ; GNU unified format diff 2-liner
141 "^--- \\([^ \t]+\\)[\t ]+.*\n\\+\\+\\+ \\([^ \t]+\\)"
142 "\\)")
143 "*Regexp matching filename 2-liners at the start of each context diff.
144 You probably don't want to change that, unless you are using an obscure patch
145 program."
146 :type 'regexp
147 :group 'ediff-ptch)
149 ;; The buffer of the patch file. Local to control buffer.
150 (ediff-defvar-local ediff-patchbufer nil "")
152 ;; The buffer where patch displays its diagnostics.
153 (ediff-defvar-local ediff-patch-diagnostics nil "")
155 ;; Map of patch buffer. Has the form:
156 ;; ((filename1 marker1 marker2) (filename2 marker1 marker2) ...)
157 ;; where filenames are files to which patch would have applied the patch;
158 ;; marker1 delimits the beginning of the corresponding patch and marker2 does
159 ;; it for the end.
160 (ediff-defvar-local ediff-patch-map nil "")
162 ;; strip prefix from filename
163 ;; returns /dev/null, if can't strip prefix
164 (defsubst ediff-file-name-sans-prefix (filename prefix)
165 (save-match-data
166 (if (string-match (concat "^" prefix) filename)
167 (substring filename (match-end 0))
168 (concat "/null/" filename))))
172 ;; no longer used
173 ;; return the number of matches of regexp in buf starting from the beginning
174 (defun ediff-count-matches (regexp buf)
175 (ediff-with-current-buffer buf
176 (let ((count 0) opoint)
177 (save-excursion
178 (goto-char (point-min))
179 (while (and (not (eobp))
180 (progn (setq opoint (point))
181 (re-search-forward regexp nil t)))
182 (if (= opoint (point))
183 (forward-char 1)
184 (setq count (1+ count)))))
185 count)))
187 ;; Scan BUF (which is supposed to contain a patch) and make a list of the form
188 ;; ((nil nil filename-spec1 marker1 marker2)
189 ;; (nil nil filename-spec2 marker1 marker2) ...)
190 ;; where filename-spec[12] are files to which the `patch' program would
191 ;; have applied the patch.
192 ;; nin, nil are placeholders. See ediff-make-new-meta-list-element in
193 ;; ediff-meta.el for the explanations.
194 ;; In the beginning we don't know exactly which files need to be patched.
195 ;; We usually come up with two candidates and ediff-file-name-sans-prefix
196 ;; resolves this later.
198 ;; The marker `marker1' delimits the beginning of the corresponding patch and
199 ;; `marker2' does it for the end.
200 ;; The result of ediff-map-patch-buffer is a list, which is then assigned
201 ;; to ediff-patch-map.
202 ;; The function returns the number of elements in the list ediff-patch-map
203 (defun ediff-map-patch-buffer (buf)
204 (ediff-with-current-buffer buf
205 (let ((count 0)
206 (mark1 (move-marker (make-marker) (point-min)))
207 (mark1-end (point-min))
208 (possible-file-names '("/dev/null" . "/dev/null"))
209 mark2-end mark2 filenames
210 beg1 beg2 end1 end2
211 patch-map opoint)
212 (save-excursion
213 (goto-char (point-min))
214 (setq opoint (point))
215 (while (and (not (eobp))
216 (re-search-forward ediff-context-diff-label-regexp nil t))
217 (if (= opoint (point))
218 (forward-char 1) ; ensure progress towards the end
219 (setq mark2 (move-marker (make-marker) (match-beginning 0))
220 mark2-end (match-end 0)
221 beg1 (or (match-beginning 2) (match-beginning 4))
222 end1 (or (match-end 2) (match-end 4))
223 beg2 (or (match-beginning 3) (match-beginning 5))
224 end2 (or (match-end 3) (match-end 5)))
225 ;; possible-file-names is holding the new file names until we
226 ;; insert the old file name in the patch map
227 ;; It is a pair
228 ;; (filename-from-1st-header-line . fn from 2nd line)
229 (setq possible-file-names
230 (cons (if (and beg1 end1)
231 (buffer-substring beg1 end1)
232 "/dev/null")
233 (if (and beg2 end2)
234 (buffer-substring beg2 end2)
235 "/dev/null")))
236 ;; check for any `Index:' or `Prereq:' lines, but don't use them
237 (if (re-search-backward "^Index:" mark1-end 'noerror)
238 (move-marker mark2 (match-beginning 0)))
239 (if (re-search-backward "^Prereq:" mark1-end 'noerror)
240 (move-marker mark2 (match-beginning 0)))
242 (goto-char mark2-end)
244 (if filenames
245 (setq patch-map
246 (cons (ediff-make-new-meta-list-element
247 filenames mark1 mark2)
248 patch-map)))
249 (setq mark1 mark2
250 mark1-end mark2-end
251 filenames possible-file-names))
252 (setq opoint (point)
253 count (1+ count))))
254 (setq mark2 (point-max-marker)
255 patch-map (cons (ediff-make-new-meta-list-element
256 possible-file-names mark1 mark2)
257 patch-map))
258 (setq ediff-patch-map (nreverse patch-map))
259 count)))
261 ;; Fix up the file names in the list using the argument FILENAME
262 ;; Algorithm: find the first file's directory and cut it out from each file
263 ;; name in the patch. Prepend the directory of FILENAME to each file in the
264 ;; patch. In addition, the first file in the patch is replaced by FILENAME.
265 ;; Each file is actually a file-pair of files found in the context diff header
266 ;; In the end, for each pair, we select the shortest existing file.
267 ;; Note: Ediff doesn't recognize multi-file patches that are separated
268 ;; with the `Index:' line. It treats them as a single-file patch.
270 ;; Executes inside the patch buffer
271 (defun ediff-fixup-patch-map (filename)
272 (setq filename (expand-file-name filename))
273 (let ((actual-dir (if (file-directory-p filename)
274 ;; directory part of filename
275 (file-name-as-directory filename)
276 (file-name-directory filename)))
277 ;; Filename-spec is objA; at this point it is represented as
278 ;; (file1 . file2). We get it using ediff-get-session-objA
279 ;; directory part of the first file in the patch
280 (base-dir1 (file-name-directory
281 (car (ediff-get-session-objA-name (car ediff-patch-map)))))
282 ;; directory part of the 2nd file in the patch
283 (base-dir2 (file-name-directory
284 (cdr (ediff-get-session-objA-name (car ediff-patch-map)))))
287 ;; chop off base-dirs
288 (mapcar (lambda (session-info)
289 (let ((proposed-file-names
290 (ediff-get-session-objA-name session-info)))
291 (or (string= (car proposed-file-names) "/dev/null")
292 (setcar proposed-file-names
293 (ediff-file-name-sans-prefix
294 (car proposed-file-names) base-dir1)))
295 (or (string=
296 (cdr proposed-file-names) "/dev/null")
297 (setcdr proposed-file-names
298 (ediff-file-name-sans-prefix
299 (cdr proposed-file-names) base-dir2)))
301 ediff-patch-map)
303 ;; take the given file name into account
304 (or (file-directory-p filename)
305 (string= "/dev/null" filename)
306 (setcar (ediff-get-session-objA (car ediff-patch-map))
307 (cons (file-name-nondirectory filename)
308 (file-name-nondirectory filename))))
310 ;; prepend actual-dir
311 (mapcar (lambda (session-info)
312 (let ((proposed-file-names
313 (ediff-get-session-objA-name session-info)))
314 (if (and (string-match "^/null/" (car proposed-file-names))
315 (string-match "^/null/" (cdr proposed-file-names)))
316 ;; couldn't strip base-dir1 and base-dir2
317 ;; hence, something is wrong
318 (progn
319 (with-output-to-temp-buffer ediff-msg-buffer
320 (ediff-with-current-buffer standard-output
321 (fundamental-mode))
322 (princ
323 (format "
324 The patch file contains a context diff for
327 However, Ediff cannot infer the name of the actual file
328 to be patched on your system. If you know the correct file name,
329 please enter it now.
331 If you don't know and still would like to apply patches to
332 other files, enter /dev/null
334 (substring (car proposed-file-names) 6)
335 (substring (cdr proposed-file-names) 6))))
336 (let ((directory t)
337 user-file)
338 (while directory
339 (setq user-file
340 (read-file-name
341 "Please enter file name: "
342 actual-dir actual-dir t))
343 (if (not (file-directory-p user-file))
344 (setq directory nil)
345 (setq directory t)
346 (beep)
347 (message "%s is a directory" user-file)
348 (sit-for 2)))
349 (setcar (ediff-get-session-objA session-info)
350 (cons user-file user-file))))
351 (setcar proposed-file-names
352 (expand-file-name
353 (concat actual-dir (car proposed-file-names))))
354 (setcdr proposed-file-names
355 (expand-file-name
356 (concat actual-dir (cdr proposed-file-names)))))
358 ediff-patch-map)
359 ;; check for the shorter existing file in each pair and discard the other
360 ;; one
361 (mapcar (lambda (session-info)
362 (let* ((file1 (car (ediff-get-session-objA-name session-info)))
363 (file2 (cdr (ediff-get-session-objA-name session-info)))
364 (session-file-object
365 (ediff-get-session-objA session-info))
366 (f1-exists (file-exists-p file1))
367 (f2-exists (file-exists-p file2)))
368 (cond
369 ((and (< (length file2) (length file1))
370 f2-exists)
371 ;; replace file-pair with the winning file2
372 (setcar session-file-object file2))
373 ((and (< (length file1) (length file2))
374 f1-exists)
375 ;; replace file-pair with the winning file1
376 (setcar session-file-object file1))
377 ((and f1-exists f2-exists
378 (string= file1 file2))
379 (setcar session-file-object file1))
380 ((and f1-exists f2-exists)
381 (with-output-to-temp-buffer ediff-msg-buffer
382 (ediff-with-current-buffer standard-output
383 (fundamental-mode))
384 (princ (format "
385 Ediff has inferred that
388 are two possible targets for applying the patch.
389 Both files seem to be plausible alternatives.
391 Please advice:
392 Type `y' to use %s as the target;
393 Type `n' to use %s as the target.
395 file1 file2 file2 file1)))
396 (setcar session-file-object
397 (if (y-or-n-p (format "Use %s ? " file2))
398 file2 file1)))
399 (f2-exists (setcar session-file-object file2))
400 (f1-exists (setcar session-file-object file1))
402 (with-output-to-temp-buffer ediff-msg-buffer
403 (ediff-with-current-buffer standard-output
404 (fundamental-mode))
405 (princ "\nEdiff has inferred that")
406 (if (string= file1 file2)
407 (princ (format "
409 is the target for this patch. However, this file does not exist."
410 file1))
411 (princ (format "
414 are two possible targets for this patch. However, these files do not exist."
415 file1 file2)))
416 (princ "
417 \nPlease enter an alternative patch target ...\n"))
418 (let ((directory t)
419 target)
420 (while directory
421 (setq target (read-file-name
422 "Please enter a patch target: "
423 actual-dir actual-dir t))
424 (if (not (file-directory-p target))
425 (setq directory nil)
426 (beep)
427 (message "%s is a directory" target)
428 (sit-for 2)))
429 (setcar session-file-object target))))))
430 ediff-patch-map)
433 (defun ediff-show-patch-diagnostics ()
434 (interactive)
435 (cond ((window-live-p ediff-window-A)
436 (set-window-buffer ediff-window-A ediff-patch-diagnostics))
437 ((window-live-p ediff-window-B)
438 (set-window-buffer ediff-window-B ediff-patch-diagnostics))
439 (t (display-buffer ediff-patch-diagnostics 'not-this-window))))
441 ;; prompt for file, get the buffer
442 (defun ediff-prompt-for-patch-file ()
443 (let ((dir (cond (ediff-patch-default-directory) ; try patch default dir
444 (ediff-use-last-dir ediff-last-dir-patch)
445 (t default-directory)))
446 (coding-system-for-read ediff-coding-system-for-read))
447 (find-file-noselect
448 (read-file-name
449 (format "Patch is in file:%s "
450 (cond ((and buffer-file-name
451 (equal (expand-file-name dir)
452 (file-name-directory buffer-file-name)))
453 (concat
454 " (default "
455 (file-name-nondirectory buffer-file-name)
456 ")"))
457 (t "")))
458 dir buffer-file-name 'must-match))
462 ;; Try current buffer, then the other window's buffer. Else, give up.
463 (defun ediff-prompt-for-patch-buffer ()
464 (get-buffer
465 (read-buffer
466 "Buffer that holds the patch: "
467 (cond ((save-excursion
468 (goto-char (point-min))
469 (re-search-forward ediff-context-diff-label-regexp nil t))
470 (current-buffer))
471 ((save-window-excursion
472 (other-window 1)
473 (save-excursion
474 (goto-char (point-min))
475 (and (re-search-forward ediff-context-diff-label-regexp nil t)
476 (current-buffer)))))
477 ((save-window-excursion
478 (other-window -1)
479 (save-excursion
480 (goto-char (point-min))
481 (and (re-search-forward ediff-context-diff-label-regexp nil t)
482 (current-buffer)))))
483 (t (ediff-other-buffer (current-buffer))))
484 'must-match)))
487 (defun ediff-get-patch-buffer (&optional arg patch-buf)
488 "Obtain patch buffer. If patch is already in a buffer---use it.
489 Else, read patch file into a new buffer. If patch buffer is passed as an
490 optional argument, then use it."
491 (let ((last-nonmenu-event t) ; Emacs: don't use dialog box
492 last-command-event) ; XEmacs: don't use dialog box
494 (cond ((ediff-buffer-live-p patch-buf))
495 ;; even prefix arg: patch in buffer
496 ((and (integerp arg) (eq 0 (mod arg 2)))
497 (setq patch-buf (ediff-prompt-for-patch-buffer)))
498 ;; odd prefix arg: get patch from a file
499 ((and (integerp arg) (eq 1 (mod arg 2)))
500 (setq patch-buf (ediff-prompt-for-patch-file)))
501 (t (setq patch-buf
502 (if (y-or-n-p "Is the patch already in a buffer? ")
503 (ediff-prompt-for-patch-buffer)
504 (ediff-prompt-for-patch-file)))))
506 (ediff-with-current-buffer patch-buf
507 (goto-char (point-min))
508 (or (ediff-get-visible-buffer-window patch-buf)
509 (progn
510 (pop-to-buffer patch-buf 'other-window)
511 (select-window (previous-window)))))
512 (ediff-map-patch-buffer patch-buf)
513 patch-buf))
515 ;; Dispatch the right patch file function: regular or meta-level,
516 ;; depending on how many patches are in the patch file.
517 ;; At present, there is no support for meta-level patches.
518 ;; Should return either the ctl buffer or the meta-buffer
519 (defun ediff-dispatch-file-patching-job (patch-buf filename
520 &optional startup-hooks)
521 (ediff-with-current-buffer patch-buf
522 ;; relativize names in the patch with respect to source-file
523 (ediff-fixup-patch-map filename)
524 (if (< (length ediff-patch-map) 2)
525 (ediff-patch-file-internal
526 patch-buf
527 (if (and ediff-patch-map
528 (not (string-match
529 "^/dev/null"
530 ;; this is the file to patch
531 (ediff-get-session-objA-name (car ediff-patch-map))))
532 (> (length
533 (ediff-get-session-objA-name (car ediff-patch-map)))
535 (ediff-get-session-objA-name (car ediff-patch-map))
536 filename)
537 startup-hooks)
538 (ediff-multi-patch-internal patch-buf startup-hooks))
542 ;; When patching a buffer, never change the orig file. Instead, create a new
543 ;; buffer, ***_patched, even if the buff visits a file.
544 ;; Users who want to actually patch the buffer should use
545 ;; ediff-patch-file, not ediff-patch-buffer.
546 (defun ediff-patch-buffer-internal (patch-buf
547 buf-to-patch-name
548 &optional startup-hooks)
549 (let* ((buf-to-patch (get-buffer buf-to-patch-name))
550 (visited-file (if buf-to-patch (buffer-file-name buf-to-patch)))
551 (buf-mod-status (buffer-modified-p buf-to-patch))
552 (multifile-patch-p (> (length (ediff-with-current-buffer patch-buf
553 ediff-patch-map)) 1))
554 default-dir file-name ctl-buf)
555 (if multifile-patch-p
556 (error
557 "To apply multi-file patches, please use `ediff-patch-file'"))
559 ;; create a temp file to patch
560 (ediff-with-current-buffer buf-to-patch
561 (setq default-dir default-directory)
562 (setq file-name (ediff-make-temp-file buf-to-patch))
563 ;; temporarily switch visited file name, if any
564 (set-visited-file-name file-name)
565 ;; don't create auto-save file, if buff was visiting a file
566 (or visited-file
567 (setq buffer-auto-save-file-name nil))
568 ;; don't confuse the user with a new bufname
569 (rename-buffer buf-to-patch-name)
570 (set-buffer-modified-p nil)
571 (set-visited-file-modtime) ; sync buffer and temp file
572 (setq default-directory default-dir)
575 ;; dispatch a patch function
576 (setq ctl-buf (ediff-dispatch-file-patching-job
577 patch-buf file-name startup-hooks))
579 (ediff-with-current-buffer ctl-buf
580 (delete-file (buffer-file-name ediff-buffer-A))
581 (delete-file (buffer-file-name ediff-buffer-B))
582 (ediff-with-current-buffer ediff-buffer-A
583 (if default-dir (setq default-directory default-dir))
584 (set-visited-file-name visited-file) ; visited-file might be nil
585 (rename-buffer buf-to-patch-name)
586 (set-buffer-modified-p buf-mod-status))
587 (ediff-with-current-buffer ediff-buffer-B
588 (setq buffer-auto-save-file-name nil) ; don't create auto-save file
589 (if default-dir (setq default-directory default-dir))
590 (set-visited-file-name nil)
591 (rename-buffer (ediff-unique-buffer-name
592 (concat buf-to-patch-name "_patched") ""))
593 (set-buffer-modified-p t)))
597 ;; Traditional patch has weird return codes.
598 ;; GNU and Posix return 1 if some hanks failed and 2 in case of trouble.
599 ;; 0 is a good code in all cases.
600 ;; We'll do the concervative thing.
601 (defun ediff-patch-return-code-ok (code)
602 (eq code 0))
603 ;;; (if (eq (ediff-test-patch-utility) 'traditional)
604 ;;; (eq code 0)
605 ;;; (not (eq code 2))))
607 (defun ediff-patch-file-internal (patch-buf source-filename
608 &optional startup-hooks)
609 (setq source-filename (expand-file-name source-filename))
611 (let* ((shell-file-name ediff-shell)
612 (patch-diagnostics (get-buffer-create "*ediff patch diagnostics*"))
613 ;; ediff-find-file may use a temp file to do the patch
614 ;; so, we save source-filename and true-source-filename as a var
615 ;; that initially is source-filename but may be changed to a temp
616 ;; file for the purpose of patching.
617 (true-source-filename source-filename)
618 (target-filename source-filename)
619 ;; this ensures that the patch process gets patch buffer in the
620 ;; encoding that Emacs thinks is right for that type of text
621 (coding-system-for-write
622 (if (boundp 'buffer-file-coding-system) buffer-file-coding-system))
623 target-buf buf-to-patch file-name-magic-p
624 patch-return-code ctl-buf backup-style aux-wind)
626 (if (string-match "V" ediff-patch-options)
627 (error
628 "Ediff doesn't take the -V option in `ediff-patch-options'--sorry"))
630 ;; Make a temp file, if source-filename has a magic file handler (or if
631 ;; it is handled via auto-mode-alist and similar magic).
632 ;; Check if there is a buffer visiting source-filename and if they are in
633 ;; sync; arrange for the deletion of temp file.
634 (ediff-find-file 'true-source-filename 'buf-to-patch
635 'ediff-last-dir-patch 'startup-hooks)
637 ;; Check if source file name has triggered black magic, such as file name
638 ;; handlers or auto mode alist, and make a note of it.
639 ;; true-source-filename should be either the original name or a
640 ;; temporary file where we put the after-product of the file handler.
641 (setq file-name-magic-p (not (equal (file-truename true-source-filename)
642 (file-truename source-filename))))
644 ;; Checkout orig file, if necessary, so that the patched file
645 ;; could be checked back in.
646 (ediff-maybe-checkout buf-to-patch)
648 (ediff-with-current-buffer patch-diagnostics
649 (insert-buffer patch-buf)
650 (message "Applying patch ... ")
651 ;; fix environment for gnu patch, so it won't make numbered extensions
652 (setq backup-style (getenv "VERSION_CONTROL"))
653 (setenv "VERSION_CONTROL" nil)
654 (setq patch-return-code
655 (call-process-region
656 (point-min) (point-max)
657 shell-file-name
658 t ; delete region (which contains the patch
659 t ; insert output (patch diagnostics) in current buffer
660 nil ; don't redisplay
661 shell-command-switch ; usually -c
662 (format "%s %s %s %s"
663 ediff-patch-program
664 ediff-patch-options
665 ediff-backup-specs
666 (expand-file-name true-source-filename))
669 ;; restore environment for gnu patch
670 (setenv "VERSION_CONTROL" backup-style))
672 (message "Applying patch ... done")
673 (message "")
675 (switch-to-buffer patch-diagnostics)
676 (sit-for 0) ; synchronize - let the user see diagnostics
678 (or (and (ediff-patch-return-code-ok patch-return-code)
679 (file-exists-p
680 (concat true-source-filename ediff-backup-extension)))
681 (progn
682 (with-output-to-temp-buffer ediff-msg-buffer
683 (ediff-with-current-buffer standard-output
684 (fundamental-mode))
685 (princ (format
686 "Patch program has failed due to a bad patch file,
687 it couldn't apply all hunks, OR
688 it couldn't create the backup for the file being patched.
690 The former could be caused by a corrupt patch file or because the %S
691 program doesn't understand the format of the patch file in use.
693 The second problem might be due to an incompatibility among these settings:
694 ediff-patch-program = %S ediff-patch-options = %S
695 ediff-backup-extension = %S ediff-backup-specs = %S
697 See Ediff on-line manual for more details on these variables.
698 In particular, check the documentation for `ediff-backup-specs'.
700 In any of the above cases, Ediff doesn't compare files automatically.
701 However, if the patch was applied partially and the backup file was created,
702 you can still examine the changes via M-x ediff-files"
703 ediff-patch-program
704 ediff-patch-program
705 ediff-patch-options
706 ediff-backup-extension
707 ediff-backup-specs
709 (beep 1)
710 (if (setq aux-wind (get-buffer-window ediff-msg-buffer))
711 (progn
712 (select-window aux-wind)
713 (goto-char (point-max))))
714 (switch-to-buffer-other-window patch-diagnostics)
715 (error "Patch appears to have failed")))
717 ;; If black magic is involved, apply patch to a temp copy of the
718 ;; file. Otherwise, apply patch to the orig copy. If patch is applied
719 ;; to temp copy, we name the result old-name_patched for local files
720 ;; and temp-copy_patched for remote files. The orig file name isn't
721 ;; changed, and the temp copy of the original is later deleted.
722 ;; Without magic, the original file is renamed (usually into
723 ;; old-name_orig) and the result of patching will have the same name as
724 ;; the original.
725 (if (not file-name-magic-p)
726 (ediff-with-current-buffer buf-to-patch
727 (set-visited-file-name
728 (concat source-filename ediff-backup-extension))
729 (set-buffer-modified-p nil))
731 ;; Black magic in effect.
732 ;; If orig file was remote, put the patched file in the temp directory.
733 ;; If orig file is local, put the patched file in the directory of
734 ;; the orig file.
735 (setq target-filename
736 (concat
737 (if (ediff-file-remote-p (file-truename source-filename))
738 true-source-filename
739 source-filename)
740 "_patched"))
742 (rename-file true-source-filename target-filename t)
744 ;; arrange that the temp copy of orig will be deleted
745 (rename-file (concat true-source-filename ediff-backup-extension)
746 true-source-filename t))
748 ;; make orig buffer read-only
749 (setq startup-hooks
750 (cons 'ediff-set-read-only-in-buf-A startup-hooks))
752 ;; set up a buf for the patched file
753 (setq target-buf (find-file-noselect target-filename))
755 (setq ctl-buf
756 (ediff-buffers-internal
757 buf-to-patch target-buf nil
758 startup-hooks 'epatch))
759 (ediff-with-current-buffer ctl-buf
760 (setq ediff-patchbufer patch-buf
761 ediff-patch-diagnostics patch-diagnostics))
763 (bury-buffer patch-diagnostics)
764 (message "Type `P', if you need to see patch diagnostics")
765 ctl-buf))
767 (defun ediff-multi-patch-internal (patch-buf &optional startup-hooks)
768 (let (meta-buf)
769 (setq startup-hooks
770 ;; this sets various vars in the meta buffer inside
771 ;; ediff-prepare-meta-buffer
772 (cons `(lambda ()
773 ;; tell what to do if the user clicks on a session record
774 (setq ediff-session-action-function
775 'ediff-patch-file-form-meta
776 ediff-meta-patchbufer patch-buf) )
777 startup-hooks))
778 (setq meta-buf (ediff-prepare-meta-buffer
779 'ediff-filegroup-action
780 (ediff-with-current-buffer patch-buf
781 (cons (ediff-make-new-meta-list-header
782 nil ; regexp
783 (format "%S" patch-buf) ; obj A
784 nil nil ; objects B,C
785 nil ; merge-auto-store-dir
786 nil ; comparison-func
788 ediff-patch-map))
789 "*Ediff Session Group Panel"
790 'ediff-redraw-directory-group-buffer
791 'ediff-multifile-patch
792 startup-hooks))
793 (ediff-show-meta-buffer meta-buf)
799 ;;; Local Variables:
800 ;;; eval: (put 'ediff-defvar-local 'lisp-indent-hook 'defun)
801 ;;; eval: (put 'ediff-with-current-buffer 'lisp-indent-hook 1)
802 ;;; eval: (put 'ediff-with-current-buffer 'edebug-form-spec '(form body))
803 ;;; End:
805 ;;; arch-tag: 2fe2161e-e116-469b-90fa-5cbb44c1bd1b
806 ;;; ediff-ptch.el ends here