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