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