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