diff-mode.el 51.1 KB
Newer Older
Pavel Janík's avatar
Pavel Janík committed
1
;;; diff-mode.el --- a mode for viewing/editing context diffs
2

3 4
;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
;;   Free Software Foundation, Inc.
5 6

;; Author: Stefan Monnier <monnier@cs.yale.edu>
Pavel Janík's avatar
Pavel Janík committed
7
;; Keywords: convenience patch diff
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
25 26 27

;;; Commentary:

28
;; Provides support for font-lock, outline, navigation
29 30 31
;; commands, editing and various conversions as well as jumping
;; to the corresponding source file.

32
;; Inspired by Pavel Machek's patch-mode.el (<pavel@@atrey.karlin.mff.cuni.cz>)
Pavel Janík's avatar
Pavel Janík committed
33
;; Some efforts were spent to have it somewhat compatible with XEmacs'
34 35 36 37
;; diff-mode as well as with compilation-minor-mode

;; Bugs:

38
;; - Reverse doesn't work with normal diffs.
39 40 41

;; Todo:

42 43 44 45 46 47 48 49 50 51
;; - Add a `delete-after-apply' so C-c C-a automatically deletes hunks.
;;   Also allow C-c C-a to delete already-applied hunks.
;;
;; - Try `diff <file> <hunk>' to try and fuzzily discover the source location
;;   of a hunk.  Show then the changes between <file> and <hunk> and make it
;;   possible to apply them to <file>, <hunk-src>, or <hunk-dst>.
;;   Or maybe just make it into a ".rej to diff3-markers converter".
;;
;; - Refine hunk on a word-by-word basis.
;;
52
;; - Handle `diff -b' output in context->unified.
53 54 55 56 57 58 59

;;; Code:

(eval-when-compile (require 'cl))


(defgroup diff-mode ()
60
  "Major mode for viewing/editing diffs."
61
  :version "21.1"
62 63 64
  :group 'tools
  :group 'diff)

65
(defcustom diff-default-read-only nil
66 67 68 69
  "If non-nil, `diff-mode' buffers default to being read-only."
  :type 'boolean
  :group 'diff-mode)

70
(defcustom diff-jump-to-old-file nil
71 72
  "*Non-nil means `diff-goto-source' jumps to the old file.
Else, it jumps to the new file."
73 74
  :type 'boolean
  :group 'diff-mode)
75

76
(defcustom diff-update-on-the-fly t
77 78 79 80 81 82
  "*Non-nil means hunk headers are kept up-to-date on-the-fly.
When editing a diff file, the line numbers in the hunk headers
need to be kept consistent with the actual diff.  This can
either be done on the fly (but this sometimes interacts poorly with the
undo mechanism) or whenever the file is written (can be slow
when editing big diffs)."
83 84
  :type 'boolean
  :group 'diff-mode)
85

86 87
(defcustom diff-advance-after-apply-hunk t
  "*Non-nil means `diff-apply-hunk' will move to the next hunk after applying."
88 89
  :type 'boolean
  :group 'diff-mode)
90 91


92 93 94
(defcustom diff-mode-hook nil
  "Run after setting up the `diff-mode' major mode."
  :type 'hook
95 96
  :options '(diff-delete-empty-files diff-make-unified)
  :group 'diff-mode)
97 98 99 100

(defvar diff-outline-regexp
  "\\([*+][*+][*+] [^0-9]\\|@@ ...\\|\\*\\*\\* [0-9].\\|--- [0-9]..\\)")

101
;;;;
102
;;;; keymap, menu, ...
103
;;;;
104

105
(easy-mmode-defmap diff-mode-shared-map
106
  '(;; From Pavel Machek's patch-mode.
107 108 109 110 111 112
    ("n" . diff-hunk-next)
    ("N" . diff-file-next)
    ("p" . diff-hunk-prev)
    ("P" . diff-file-prev)
    ("k" . diff-hunk-kill)
    ("K" . diff-file-kill)
113
    ;; From compilation-minor-mode.
114 115
    ("}" . diff-file-next)
    ("{" . diff-file-prev)
116
    ("\C-m" . diff-goto-source)
117
    ([mouse-2] . diff-goto-source)
118
    ;; From XEmacs' diff-mode.
119 120 121 122 123 124 125 126 127 128 129
    ("W" . widen)
    ;;("." . diff-goto-source)		;display-buffer
    ;;("f" . diff-goto-source)		;find-file
    ("o" . diff-goto-source)		;other-window
    ;;("w" . diff-goto-source)		;other-frame
    ;;("N" . diff-narrow)
    ;;("h" . diff-show-header)
    ;;("j" . diff-show-difference)	;jump to Nth diff
    ;;("q" . diff-quit)
    (" " . scroll-up)
    ("\177" . scroll-down)
130
    ;; Our very own bindings.
131 132 133 134
    ("A" . diff-ediff-patch)
    ("r" . diff-restrict-view)
    ("R" . diff-reverse-direction)
    ("U" . diff-context->unified)
Benjamin Rutt's avatar
Benjamin Rutt committed
135 136
    ("C" . diff-unified->context)
    ("q" . quit-window))
137
  "Basic keymap for `diff-mode', bound to various prefix keys.")
138

139
(easy-mmode-defmap diff-mode-map
140
  `(("\e" . ,diff-mode-shared-map)
141 142 143
    ;; From compilation-minor-mode.
    ("\C-c\C-c" . diff-goto-source)
    ;; Misc operations.
144
    ("\C-c\C-r" . diff-refine-hunk)
145
    ("\C-c\C-s" . diff-split-hunk)
146
    ("\C-c\C-a" . diff-apply-hunk)
147
    ("\C-c\C-t" . diff-test-hunk)
148
    ("\C-c\C-f" . next-error-follow-minor-mode))
149 150 151 152 153 154
  "Keymap for `diff-mode'.  See also `diff-mode-shared-map'.")

(easy-menu-define diff-mode-menu diff-mode-map
  "Menu for `diff-mode'."
  '("Diff"
    ["Jump to Source"		diff-goto-source	t]
155 156
    ["Apply hunk"		diff-apply-hunk		t]
    ["Apply diff with Ediff"	diff-ediff-patch	t]
157 158 159 160 161 162 163
    ["-----" nil nil]
    ["Reverse direction"	diff-reverse-direction	t]
    ["Context -> Unified"	diff-context->unified	t]
    ["Unified -> Context"	diff-unified->context	t]
    ;;["Fixup Headers"		diff-fixup-modifs	(not buffer-read-only)]
    ))

164
(defcustom diff-minor-mode-prefix "\C-c="
165
  "Prefix key for `diff-minor-mode' commands."
166 167
  :type '(choice (string "\e") (string "C-c=") string)
  :group 'diff-mode)
168

169 170
(easy-mmode-defmap diff-minor-mode-map
  `((,diff-minor-mode-prefix . ,diff-mode-shared-map))
171 172
  "Keymap for `diff-minor-mode'.  See also `diff-mode-shared-map'.")

173

174
;;;;
175
;;;; font-lock support
176
;;;;
177

178
(defface diff-header
179
  '((((class color) (min-colors 88) (background light))
180
     :background "grey85")
181
    (((class color) (min-colors 88) (background dark))
182
     :background "grey45")
183
    (((class color) (background light))
184
     :foreground "blue1" :weight bold)
185
    (((class color) (background dark))
186 187
     :foreground "green" :weight bold)
    (t :weight bold))
188 189
  "`diff-mode' face inherited by hunk and index header faces."
  :group 'diff-mode)
190 191 192
;; backward-compatibility alias
(put 'diff-header-face 'face-alias 'diff-header)
(defvar diff-header-face 'diff-header)
Stefan Monnier's avatar
Stefan Monnier committed
193

194
(defface diff-file-header
195
  '((((class color) (min-colors 88) (background light))
196
     :background "grey70" :weight bold)
197
    (((class color) (min-colors 88) (background dark))
198
     :background "grey60" :weight bold)
199
    (((class color) (background light))
200
     :foreground "yellow" :weight bold)
201
    (((class color) (background dark))
202 203
     :foreground "cyan" :weight bold)
    (t :weight bold))			; :height 1.3
204 205
  "`diff-mode' face used to highlight file header lines."
  :group 'diff-mode)
206 207 208
;; backward-compatibility alias
(put 'diff-file-header-face 'face-alias 'diff-file-header)
(defvar diff-file-header-face 'diff-file-header)
209

210 211
(defface diff-index
  '((t :inherit diff-file-header))
212 213
  "`diff-mode' face used to highlight index header lines."
  :group 'diff-mode)
214 215 216
;; backward-compatibility alias
(put 'diff-index-face 'face-alias 'diff-index)
(defvar diff-index-face 'diff-index)
217

218 219
(defface diff-hunk-header
  '((t :inherit diff-header))
220 221
  "`diff-mode' face used to highlight hunk header lines."
  :group 'diff-mode)
222 223 224
;; backward-compatibility alias
(put 'diff-hunk-header-face 'face-alias 'diff-hunk-header)
(defvar diff-hunk-header-face 'diff-hunk-header)
225

226 227
(defface diff-removed
  '((t :inherit diff-changed))
228 229
  "`diff-mode' face used to highlight removed lines."
  :group 'diff-mode)
230 231 232
;; backward-compatibility alias
(put 'diff-removed-face 'face-alias 'diff-removed)
(defvar diff-removed-face 'diff-removed)
233

234 235
(defface diff-added
  '((t :inherit diff-changed))
236 237
  "`diff-mode' face used to highlight added lines."
  :group 'diff-mode)
238 239 240
;; backward-compatibility alias
(put 'diff-added-face 'face-alias 'diff-added)
(defvar diff-added-face 'diff-added)
241

242
(defface diff-changed
243
  '((((type tty pc) (class color) (background light))
244
     :foreground "magenta" :weight bold :slant italic)
245
    (((type tty pc) (class color) (background dark))
246
     :foreground "yellow" :weight bold :slant italic))
247 248
  "`diff-mode' face used to highlight changed lines."
  :group 'diff-mode)
249 250 251
;; backward-compatibility alias
(put 'diff-changed-face 'face-alias 'diff-changed)
(defvar diff-changed-face 'diff-changed)
252

253 254
(defface diff-function
  '((t :inherit diff-context))
255 256
  "`diff-mode' face used to highlight function names produced by \"diff -p\"."
  :group 'diff-mode)
257 258 259
;; backward-compatibility alias
(put 'diff-function-face 'face-alias 'diff-function)
(defvar diff-function-face 'diff-function)
260

261
(defface diff-context
262
  '((t :inherit shadow))
263 264
  "`diff-mode' face used to highlight context and other side-information."
  :group 'diff-mode)
265 266 267
;; backward-compatibility alias
(put 'diff-context-face 'face-alias 'diff-context)
(defvar diff-context-face 'diff-context)
Stefan Monnier's avatar
Stefan Monnier committed
268

269 270
(defface diff-nonexistent
  '((t :inherit diff-file-header))
271 272
  "`diff-mode' face used to highlight nonexistent files in recursive diffs."
  :group 'diff-mode)
273 274 275
;; backward-compatibility alias
(put 'diff-nonexistent-face 'face-alias 'diff-nonexistent)
(defvar diff-nonexistent-face 'diff-nonexistent)
276

277 278
(defconst diff-yank-handler '(diff-yank-function))
(defun diff-yank-function (text)
279 280 281
  ;; FIXME: the yank-handler is now called separately on each piece of text
  ;; with a yank-handler property, so the next-single-property-change call
  ;; below will always return nil :-(   --stef
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
  (let ((mixed (next-single-property-change 0 'yank-handler text))
	(start (point)))
    ;; First insert the text.
    (insert text)
    ;; If the text does not include any diff markers and if we're not
    ;; yanking back into a diff-mode buffer, get rid of the prefixes.
    (unless (or mixed (derived-mode-p 'diff-mode))
      (undo-boundary)		; Just in case the user wanted the prefixes.
      (let ((re (save-excursion
		  (if (re-search-backward "^[><!][ \t]" start t)
		      (if (eq (char-after) ?!)
			  "^[!+- ][ \t]" "^[<>][ \t]")
		    "^[ <>!+-]"))))
	(save-excursion
	  (while (re-search-backward re start t)
	    (replace-match "" t t)))))))
298

299

300
(defvar diff-font-lock-keywords
301
  `(("^\\(@@ -[0-9,]+ \\+[0-9,]+ @@\\)\\(.*\\)$" ;unified
302
     (1 diff-hunk-header-face)
303
     (2 diff-function-face))
304
    ("^--- .+ ----$" . diff-hunk-header-face) ;context
305
    ("^\\(\\*\\{15\\}\\)\\(.*\\)$"	;context
306
     (1 diff-hunk-header-face)
307
     (2 diff-function-face))
308
    ("^\\*\\*\\* .+ \\*\\*\\*\\*". diff-hunk-header-face) ;context
309
    ("^\\(---\\|\\+\\+\\+\\|\\*\\*\\*\\) \\(\\S-+\\)\\(.*[^*-]\\)?\n"
Stefan Monnier's avatar
Stefan Monnier committed
310
     (0 diff-header-face) (2 diff-file-header-face prepend))
311
    ("^[0-9,]+[acd][0-9,]+$" . diff-hunk-header-face)
312 313 314
    ("^!.*\n" (0 diff-changed-face))
    ("^[+>].*\n" (0 diff-added-face))
    ("^[-<].*\n" (0 diff-removed-face))
Stefan Monnier's avatar
Stefan Monnier committed
315
    ("^Index: \\(.+\\).*\n" (0 diff-header-face) (1 diff-index-face prepend))
316
    ("^Only in .*\n" . diff-nonexistent-face)
317
    ("^#.*" . font-lock-string-face)
318
    ("^[^-=+*!<>].*\n" (0 diff-context-face))))
319 320

(defconst diff-font-lock-defaults
321
  '(diff-font-lock-keywords t nil nil nil (font-lock-multiline . nil)))
322

323 324
(defvar diff-imenu-generic-expression
  ;; Prefer second name as first is most likely to be a backup or
325 326 327
  ;; version-control name.  The [\t\n] at the end of the unidiff pattern
  ;; catches Debian source diff files (which lack the trailing date).
  '((nil "\\+\\+\\+\\ \\([^\t\n]+\\)[\t\n]" 1) ; unidiffs
328 329
    (nil "^--- \\([^\t\n]+\\)\t.*\n\\*" 1))) ; context diffs

330
;;;;
331
;;;; Movement
332
;;;;
333

334
(defconst diff-hunk-header-re "^\\(@@ -[0-9,]+ \\+[0-9,]+ @@.*\\|\\*\\{15\\}.*\n\\*\\*\\* .+ \\*\\*\\*\\*\\|[0-9]+\\(,[0-9]+\\)?[acd][0-9]+\\(,[0-9]+\\)?\\)$")
335
(defconst diff-file-header-re (concat "^\\(--- .+\n\\+\\+\\+ \\|\\*\\*\\* .+\n--- \\|[^-+!<>0-9@* ]\\).+\n" (substring diff-hunk-header-re 1)))
336 337 338
(defvar diff-narrowed-to nil)

(defun diff-end-of-hunk (&optional style)
339 340 341 342 343
  (when (looking-at diff-hunk-header-re)
    (unless style
      ;; Especially important for unified (because headers are ambiguous).
      (setq style (cdr (assq (char-after) '((?@ . unified) (?* . context))))))
    (goto-char (match-end 0)))
344
  (let ((end (and (re-search-forward (case style
345 346 347
				       ;; A `unified' header is ambiguous.
				       (unified (concat "^[^-+# \\]\\|"
							diff-file-header-re))
348 349 350 351 352 353 354
				       (context "^[^-+#! \\]")
				       (normal "^[^<>#\\]")
				       (t "^[^-+#!<> \\]"))
				     nil t)
		  (match-beginning 0))))
    ;; The return value is used by easy-mmode-define-navigation.
    (goto-char (or end (point-max)))))
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372

(defun diff-beginning-of-hunk ()
  (beginning-of-line)
  (unless (looking-at diff-hunk-header-re)
    (forward-line 1)
    (condition-case ()
	(re-search-backward diff-hunk-header-re)
      (error (error "Can't find the beginning of the hunk")))))

(defun diff-beginning-of-file ()
  (beginning-of-line)
  (unless (looking-at diff-file-header-re)
    (forward-line 2)
    (condition-case ()
	(re-search-backward diff-file-header-re)
      (error (error "Can't find the beginning of the file")))))

(defun diff-end-of-file ()
373
  (re-search-forward "^[-+#!<>0-9@* \\]" nil t)
374 375 376 377 378
  (re-search-forward (concat "^[^-+#!<>0-9@* \\]\\|" diff-file-header-re)
		     nil 'move)
  (if (match-beginning 1)
      (goto-char (match-beginning 1))
    (beginning-of-line)))
379

380 381
;; Define diff-{hunk,file}-{prev,next}
(easy-mmode-define-navigation
382
 diff-hunk diff-hunk-header-re "hunk" diff-end-of-hunk diff-restrict-view)
383 384
(easy-mmode-define-navigation
 diff-file diff-file-header-re "file" diff-end-of-hunk)
385 386 387 388 389 390 391 392 393 394 395 396 397

(defun diff-restrict-view (&optional arg)
  "Restrict the view to the current hunk.
If the prefix ARG is given, restrict the view to the current file instead."
  (interactive "P")
  (save-excursion
    (if arg (diff-beginning-of-file) (diff-beginning-of-hunk))
    (narrow-to-region (point)
		      (progn (if arg (diff-end-of-file) (diff-end-of-hunk))
			     (point)))
    (set (make-local-variable 'diff-narrowed-to) (if arg 'file 'hunk))))


398
(defun diff-hunk-kill ()
399 400 401
  "Kill current hunk."
  (interactive)
  (diff-beginning-of-hunk)
402
  (let* ((start (point))
403 404
	 (nexthunk (when (re-search-forward diff-hunk-header-re nil t)
		     (match-beginning 0)))
405 406 407 408 409
	 (firsthunk (ignore-errors
		      (goto-char start)
		      (diff-beginning-of-file) (diff-hunk-next) (point)))
	 (nextfile (ignore-errors (diff-file-next) (point))))
    (goto-char start)
410 411 412
    (if (and firsthunk (= firsthunk start)
	     (or (null nexthunk)
		 (and nextfile (> nexthunk nextfile))))
413
	;; It's the only hunk for this file, so kill the file.
414
	(diff-file-kill)
415 416 417
      (diff-end-of-hunk)
      (kill-region start (point)))))

418
(defun diff-file-kill ()
419 420 421 422 423 424
  "Kill current file's hunks."
  (interactive)
  (diff-beginning-of-file)
  (let* ((start (point))
	 (prevhunk (save-excursion
		     (ignore-errors
425
		       (diff-hunk-prev) (point))))
426 427 428 429
	 (index (save-excursion
		  (re-search-backward "^Index: " prevhunk t))))
    (when index (setq start index))
    (diff-end-of-file)
430
    (if (looking-at "^\n") (forward-char 1)) ;`tla' generates such diffs.
431 432
    (kill-region start (point))))

433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
(defun diff-kill-junk ()
  "Kill spurious empty diffs."
  (interactive)
  (save-excursion
    (let ((inhibit-read-only t))
      (goto-char (point-min))
      (while (re-search-forward (concat "^\\(Index: .*\n\\)"
					"\\([^-+!* <>].*\n\\)*?"
					"\\(\\(Index:\\) \\|"
					diff-file-header-re "\\)")
				nil t)
	(delete-region (if (match-end 4) (match-beginning 0) (match-end 1))
		       (match-beginning 3))
	(beginning-of-line)))))

448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
(defun diff-count-matches (re start end)
  (save-excursion
    (let ((n 0))
      (goto-char start)
      (while (re-search-forward re end t) (incf n))
      n)))

(defun diff-split-hunk ()
  "Split the current (unified diff) hunk at point into two hunks."
  (interactive)
  (beginning-of-line)
  (let ((pos (point))
	(start (progn (diff-beginning-of-hunk) (point))))
    (unless (looking-at "@@ -\\([0-9]+\\),[0-9]+ \\+\\([0-9]+\\),[0-9]+ @@")
      (error "diff-split-hunk only works on unified context diffs"))
    (forward-line 1)
    (let* ((start1 (string-to-number (match-string 1)))
	   (start2 (string-to-number (match-string 2)))
	   (newstart1 (+ start1 (diff-count-matches "^[- \t]" (point) pos)))
	   (newstart2 (+ start2 (diff-count-matches "^[+ \t]" (point) pos))))
      (goto-char pos)
      ;; Hopefully the after-change-function will not screw us over.
      (insert "@@ -" (number-to-string newstart1) ",1 +"
	      (number-to-string newstart2) ",1 @@\n")
      ;; Fix the original hunk-header.
      (diff-fixup-modifs start pos))))
474

475

476 477 478 479
;;;;
;;;; jump to other buffers
;;;;

480 481
(defvar diff-remembered-files-alist nil)

482 483 484
(defun diff-filename-drop-dir (file)
  (when (string-match "/" file) (substring file (match-end 0))))

485 486 487
(defun diff-merge-strings (ancestor from to)
  "Merge the diff between ANCESTOR and FROM into TO.
Returns the merged string if successful or nil otherwise.
488
The strings are assumed not to contain any \"\\n\" (i.e. end of line).
489 490 491 492 493 494 495 496
If ANCESTOR = FROM, returns TO.
If ANCESTOR = TO, returns FROM.
The heuristic is simplistic and only really works for cases
like \(diff-merge-strings \"b/foo\" \"b/bar\" \"/a/c/foo\")."
  ;; Ideally, we want:
  ;;   AMB ANB CMD -> CND
  ;; but that's ambiguous if `foo' or `bar' is empty:
  ;; a/foo a/foo1 b/foo.c -> b/foo1.c but not 1b/foo.c or b/foo.c1
497
  (let ((str (concat ancestor "\n" from "\n" to)))
498
    (when (and (string-match (concat
499 500
			      "\\`\\(.*?\\)\\(.*\\)\\(.*\\)\n"
			      "\\1\\(.*\\)\\3\n"
501 502 503 504 505 506
			      "\\(.*\\(\\2\\).*\\)\\'") str)
	       (equal to (match-string 5 str)))
      (concat (substring str (match-beginning 5) (match-beginning 6))
	      (match-string 4 str)
	      (substring str (match-end 6) (match-end 5))))))

507 508 509 510 511 512 513 514 515 516 517 518
(defun diff-tell-file-name (old name)
  "Tell Emacs where the find the source file of the current hunk.
If the OLD prefix arg is passed, tell the file NAME of the old file."
  (interactive
   (let* ((old current-prefix-arg)
	  (fs (diff-hunk-file-names current-prefix-arg)))
     (unless fs (error "No file name to look for"))
     (list old (read-file-name (format "File for %s: " (car fs))
			       nil (diff-find-file-name old) t))))
  (let ((fs (diff-hunk-file-names old)))
    (unless fs (error "No file name to look for"))
    (push (cons fs name) diff-remembered-files-alist)))
519

520 521
(defun diff-hunk-file-names (&optional old)
  "Give the list of file names textually mentioned for the current hunk."
522 523 524 525
  (save-excursion
    (unless (looking-at diff-file-header-re)
      (or (ignore-errors (diff-beginning-of-file))
	  (re-search-forward diff-file-header-re nil t)))
526
    (let ((limit (save-excursion
527
		   (condition-case ()
528
		       (progn (diff-hunk-prev) (point))
529
		     (error (point-min)))))
530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
	  (header-files
	   (if (looking-at "[-*][-*][-*] \\(\\S-+\\)\\(\\s-.*\\)?\n[-+][-+][-+] \\(\\S-+\\)")
	       (list (if old (match-string 1) (match-string 3))
		     (if old (match-string 3) (match-string 1)))
	     (forward-line 1) nil)))
      (delq nil
	    (append
	     (when (and (not old)
			(save-excursion
			  (re-search-backward "^Index: \\(.+\\)" limit t)))
	       (list (match-string 1)))
	     header-files
	     (when (re-search-backward
		    "^diff \\(-\\S-+ +\\)*\\(\\S-+\\)\\( +\\(\\S-+\\)\\)?"
		    nil t)
	       (list (if old (match-string 2) (match-string 4))
		     (if old (match-string 4) (match-string 2)))))))))

(defun diff-find-file-name (&optional old)
  "Return the file corresponding to the current patch.
Non-nil OLD means that we want the old file."
  (save-excursion
    (unless (looking-at diff-file-header-re)
      (or (ignore-errors (diff-beginning-of-file))
	  (re-search-forward diff-file-header-re nil t)))
    (let ((fs (diff-hunk-file-names old)))
556
      (or
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
       ;; use any previously used preference
       (cdr (assoc fs diff-remembered-files-alist))
       ;; try to be clever and use previous choices as an inspiration
       (dolist (rf diff-remembered-files-alist)
	 (let ((newfile (diff-merge-strings (caar rf) (car fs) (cdr rf))))
	   (if (and newfile (file-exists-p newfile)) (return newfile))))
       ;; look for each file in turn.  If none found, try again but
       ;; ignoring the first level of directory, ...
       (do* ((files fs (delq nil (mapcar 'diff-filename-drop-dir files)))
	     (file nil nil))
	   ((or (null files)
		(setq file (do* ((files files (cdr files))
				 (file (car files) (car files)))
			       ((or (null file) (file-exists-p file))
				file))))
	    file))
       ;; <foo>.rej patches implicitly apply to <foo>
574 575 576
       (and (string-match "\\.rej\\'" (or buffer-file-name ""))
	    (let ((file (substring buffer-file-name 0 (match-beginning 0))))
	      (when (file-exists-p file) file)))
577 578 579 580 581
       ;; if all else fails, ask the user
       (let ((file (read-file-name (format "Use file %s: " (or (first fs) ""))
				   nil (first fs) t (first fs))))
	 (set (make-local-variable 'diff-remembered-files-alist)
	      (cons (cons fs file) diff-remembered-files-alist))
582 583
	 file)))))

584

585 586 587 588
(defun diff-ediff-patch ()
  "Call `ediff-patch-file' on the current buffer."
  (interactive)
  (condition-case err
589
      (ediff-patch-file nil (current-buffer))
590 591
    (wrong-number-of-arguments (ediff-patch-file))))

592
;;;;
593
;;;; Conversion functions
594
;;;;
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610

;;(defvar diff-inhibit-after-change nil
;;  "Non-nil means inhibit `diff-mode's after-change functions.")

(defun diff-unified->context (start end)
  "Convert unified diffs to context diffs.
START and END are either taken from the region (if a prefix arg is given) or
else cover the whole bufer."
  (interactive (if current-prefix-arg
		   (list (mark) (point))
		 (list (point-min) (point-max))))
  (unless (markerp end) (setq end (copy-marker end)))
  (let (;;(diff-inhibit-after-change t)
	(inhibit-read-only t))
    (save-excursion
      (goto-char start)
611
      (while (and (re-search-forward "^\\(\\(---\\) .+\n\\(\\+\\+\\+\\) .+\\|@@ -\\([0-9]+\\),\\([0-9]+\\) \\+\\([0-9]+\\),\\([0-9]+\\) @@.*\\)$" nil t)
612 613 614
		  (< (point) end))
	(combine-after-change-calls
	  (if (match-beginning 2)
615
	      ;; we matched a file header
616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
	      (progn
		;; use reverse order to make sure the indices are kept valid
		(replace-match "---" t t nil 3)
		(replace-match "***" t t nil 2))
	    ;; we matched a hunk header
	    (let ((line1 (match-string 4))
		  (lines1 (match-string 5))
		  (line2 (match-string 6))
		  (lines2 (match-string 7)))
	      (replace-match
	       (concat "***************\n*** " line1 ","
		       (number-to-string (+ (string-to-number line1)
					    (string-to-number lines1)
					    -1)) " ****"))
	      (forward-line 1)
	      (save-restriction
		(narrow-to-region (point)
				  (progn (diff-end-of-hunk 'unified) (point)))
		(let ((hunk (buffer-string)))
		  (goto-char (point-min))
		  (if (not (save-excursion (re-search-forward "^-" nil t)))
		      (delete-region (point) (point-max))
		    (goto-char (point-max))
		    (let ((modif nil) last-pt)
		      (while (progn (setq last-pt (point))
				    (= (forward-line -1) 0))
			(case (char-after)
Juanma Barranquero's avatar
Juanma Barranquero committed
643
			  (?\s (insert " ") (setq modif nil) (backward-char 1))
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667
			  (?+ (delete-region (point) last-pt) (setq modif t))
			  (?- (if (not modif)
				  (progn (forward-char 1)
					 (insert " "))
				(delete-char 1)
				(insert "! "))
			      (backward-char 2))
			  (?\\ (when (save-excursion (forward-line -1)
						     (= (char-after) ?+))
				 (delete-region (point) last-pt) (setq modif t)))
			  (t (setq modif nil))))))
		  (goto-char (point-max))
		  (save-excursion
		    (insert "--- " line2 ","
			    (number-to-string (+ (string-to-number line2)
						 (string-to-number lines2)
						 -1)) " ----\n" hunk))
		  ;;(goto-char (point-min))
		  (forward-line 1)
		  (if (not (save-excursion (re-search-forward "^+" nil t)))
		      (delete-region (point) (point-max))
		    (let ((modif nil) (delete nil))
		      (while (not (eobp))
			(case (char-after)
Juanma Barranquero's avatar
Juanma Barranquero committed
668
			  (?\s (insert " ") (setq modif nil) (backward-char 1))
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
			  (?- (setq delete t) (setq modif t))
			  (?+ (if (not modif)
				  (progn (forward-char 1)
					 (insert " "))
				(delete-char 1)
				(insert "! "))
			      (backward-char 2))
			  (?\\ (when (save-excursion (forward-line 1)
						     (not (eobp)))
				 (setq delete t) (setq modif t)))
			  (t (setq modif nil)))
			(let ((last-pt (point)))
			  (forward-line 1)
			  (when delete
			    (delete-region last-pt (point))
			    (setq delete nil)))))))))))))))

(defun diff-context->unified (start end)
  "Convert context diffs to unified diffs.
START and END are either taken from the region (if a prefix arg is given) or
else cover the whole bufer."
  (interactive (if current-prefix-arg
		   (list (mark) (point))
		 (list (point-min) (point-max))))
  (unless (markerp end) (setq end (copy-marker end)))
  (let (;;(diff-inhibit-after-change t)
	(inhibit-read-only t))
    (save-excursion
      (goto-char start)
698
      (while (and (re-search-forward "^\\(\\(\\*\\*\\*\\) .+\n\\(---\\) .+\\|\\*\\{15\\}.*\n\\*\\*\\* \\([0-9]+\\),\\(-?[0-9]+\\) \\*\\*\\*\\*\\)$" nil t)
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725
		  (< (point) end))
	(combine-after-change-calls
	  (if (match-beginning 2)
	      ;; we matched a file header
	      (progn
		;; use reverse order to make sure the indices are kept valid
		(replace-match "+++" t t nil 3)
		(replace-match "---" t t nil 2))
	    ;; we matched a hunk header
	    (let ((line1s (match-string 4))
		  (line1e (match-string 5))
		  (pt1 (match-beginning 0)))
	      (replace-match "")
	      (unless (re-search-forward
		       "^--- \\([0-9]+\\),\\(-?[0-9]+\\) ----$" nil t)
		(error "Can't find matching `--- n1,n2 ----' line"))
	      (let ((line2s (match-string 1))
		    (line2e (match-string 2))
		    (pt2 (progn
			   (delete-region (progn (beginning-of-line) (point))
					  (progn (forward-line 1) (point)))
			   (point-marker))))
		(goto-char pt1)
		(forward-line 1)
		(while (< (point) pt2)
		  (case (char-after)
		    ((?! ?-) (delete-char 2) (insert "-") (forward-line 1))
726
		    (?\s		;merge with the other half of the chunk
727 728 729 730 731 732 733 734 735
		     (let* ((endline2
			     (save-excursion
			       (goto-char pt2) (forward-line 1) (point)))
			    (c (char-after pt2)))
		       (case c
			 ((?! ?+)
			  (insert "+"
				  (prog1 (buffer-substring (+ pt2 2) endline2)
				    (delete-region pt2 endline2))))
736
			 (?\s		;FIXME: check consistency
737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
			  (delete-region pt2 endline2)
			  (delete-char 1)
			  (forward-line 1))
			 (?\\ (forward-line 1))
			 (t (delete-char 1) (forward-line 1)))))
		    (t (forward-line 1))))
		(while (looking-at "[+! ] ")
		  (if (/= (char-after) ?!) (forward-char 1)
		    (delete-char 1) (insert "+"))
		  (delete-char 1) (forward-line 1))
		(save-excursion
		  (goto-char pt1)
		  (insert "@@ -" line1s ","
			  (number-to-string (- (string-to-number line1e)
					       (string-to-number line1s)
					       -1))
			  " +" line2s ","
			  (number-to-string (- (string-to-number line2e)
					       (string-to-number line2s)
					       -1)) " @@"))))))))))

(defun diff-reverse-direction (start end)
  "Reverse the direction of the diffs.
START and END are either taken from the region (if a prefix arg is given) or
else cover the whole bufer."
  (interactive (if current-prefix-arg
		   (list (mark) (point))
		 (list (point-min) (point-max))))
  (unless (markerp end) (setq end (copy-marker end)))
  (let (;;(diff-inhibit-after-change t)
	(inhibit-read-only t))
    (save-excursion
      (goto-char start)
770
      (while (and (re-search-forward "^\\(\\([-*][-*][-*] \\)\\(.+\\)\n\\([-+][-+][-+] \\)\\(.+\\)\\|\\*\\{15\\}.*\n\\*\\*\\* \\(.+\\) \\*\\*\\*\\*\\|@@ -\\([0-9,]+\\) \\+\\([0-9,]+\\) @@.*\\)$" nil t)
771 772 773 774 775 776 777 778 779 780 781 782
		  (< (point) end))
	(combine-after-change-calls
	  (cond
	   ;; a file header
	   ((match-beginning 2) (replace-match "\\2\\5\n\\4\\3" nil))
	   ;; a context-diff hunk header
	   ((match-beginning 6)
	    (let ((pt-lines1 (match-beginning 6))
		  (lines1 (match-string 6)))
	      (replace-match "" nil nil nil 6)
	      (forward-line 1)
	      (let ((half1s (point)))
783
		(while (looking-at "[-! \\][ \t]\\|#")
784 785
		  (when (= (char-after) ?-) (delete-char 1) (insert "+"))
		  (forward-line 1))
786
		(let ((half1 (delete-and-extract-region half1s (point))))
787 788 789 790 791 792 793
		  (unless (looking-at "^--- \\([0-9]+,-?[0-9]+\\) ----$")
		    (insert half1)
		    (error "Can't find matching `--- n1,n2 ----' line"))
		  (let ((str1 (match-string 1)))
		    (replace-match lines1 nil nil nil 1)
		    (forward-line 1)
		    (let ((half2s (point)))
794
		      (while (looking-at "[!+ \\][ \t]\\|#")
795 796
			(when (= (char-after) ?+) (delete-char 1) (insert "-"))
			(forward-line 1))
797
		      (let ((half2 (delete-and-extract-region half2s (point))))
798
			(insert (or half1 ""))
799
			(goto-char half1s)
800
			(insert (or half2 ""))))
801 802 803 804 805 806 807 808 809 810 811 812
		    (goto-char pt-lines1)
		    (insert str1))))))
	   ;; a unified-diff hunk header
	   ((match-beginning 7)
	    (replace-match "@@ -\\8 +\\7 @@" nil)
	    (forward-line 1)
	    (let ((c (char-after)) first last)
	      (while (case (setq c (char-after))
		       (?- (setq first (or first (point)))
			   (delete-char 1) (insert "+") t)
		       (?+ (setq last (or last (point)))
			   (delete-char 1) (insert "-") t)
813
		       ((?\\ ?#) t)
814
		       (t (when (and first last (< first last))
815
			    (insert (delete-and-extract-region first last)))
816
			  (setq first nil last nil)
817
			  (equal ?\s c)))
818 819 820 821 822 823 824 825 826 827 828 829 830 831
		(forward-line 1))))))))))

(defun diff-fixup-modifs (start end)
  "Fixup the hunk headers (in case the buffer was modified).
START and END are either taken from the region (if a prefix arg is given) or
else cover the whole bufer."
  (interactive (if current-prefix-arg
		   (list (mark) (point))
		 (list (point-min) (point-max))))
  (let ((inhibit-read-only t))
    (save-excursion
      (goto-char end) (diff-end-of-hunk)
      (let ((plus 0) (minus 0) (space 0) (bang 0))
	(while (and (= (forward-line -1) 0) (<= start (point)))
832 833 834 835
	  (if (not (looking-at
		    (concat "@@ -[0-9,]+ \\+[0-9,]+ @@"
			    "\\|[-*][-*][-*] [0-9,]+ [-*][-*][-*][-*]$"
			    "\\|--- .+\n\\+\\+\\+ ")))
836
	      (case (char-after)
837
		(?\s (incf space))
838 839 840
		(?+ (incf plus))
		(?- (incf minus))
		(?! (incf bang))
841
		((?\\ ?#) nil)
842 843
		(t  (setq space 0 plus 0 minus 0 bang 0)))
	    (cond
844
	     ((looking-at "@@ -[0-9]+,\\([0-9]*\\) \\+[0-9]+,\\([0-9]*\\) @@.*$")
845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866
	      (let* ((old1 (match-string 1))
		     (old2 (match-string 2))
		     (new1 (number-to-string (+ space minus)))
		     (new2 (number-to-string (+ space plus))))
		(unless (string= new2 old2) (replace-match new2 t t nil 2))
		(unless (string= new1 old1) (replace-match new1 t t nil 1))))
	     ((looking-at "--- \\([0-9]+\\),\\([0-9]*\\) ----$")
	      (when (> (+ space bang plus) 0)
		(let* ((old1 (match-string 1))
		       (old2 (match-string 2))
		       (new (number-to-string
			     (+ space bang plus -1 (string-to-number old1)))))
		  (unless (string= new old2) (replace-match new t t nil 2)))))
	     ((looking-at "\\*\\*\\* \\([0-9]+\\),\\(-?[0-9]*\\) \\*\\*\\*\\*$")
	      (when (> (+ space bang minus) 0)
		(let* ((old (match-string 1))
		       (new (format
			     (concat "%0" (number-to-string (length old)) "d")
			     (+ space bang minus -1 (string-to-number old)))))
		  (unless (string= new old) (replace-match new t t nil 2))))))
	    (setq space 0 plus 0 minus 0 bang 0)))))))

867
;;;;
868
;;;; Hooks
869
;;;;
870 871 872 873 874 875 876 877 878 879 880 881 882

(defun diff-write-contents-hooks ()
  "Fixup hunk headers if necessary."
  (if (buffer-modified-p) (diff-fixup-modifs (point-min) (point-max)))
  nil)

;; It turns out that making changes in the buffer from within an
;; *-change-function is asking for trouble, whereas making them
;; from a post-command-hook doesn't pose much problems
(defvar diff-unhandled-changes nil)
(defun diff-after-change-function (beg end len)
  "Remember to fixup the hunk header.
See `after-change-functions' for the meaning of BEG, END and LEN."
883 884 885 886 887
  ;; Ignoring changes when inhibit-read-only is set is strictly speaking
  ;; incorrect, but it turns out that inhibit-read-only is normally not set
  ;; inside editing commands, while it tends to be set when the buffer gets
  ;; updated by an async process or by a conversion function, both of which
  ;; would rather not be uselessly slowed down by this hook.
888 889 890 891
  (when (and (not undo-in-progress) (not inhibit-read-only))
    (if diff-unhandled-changes
	(setq diff-unhandled-changes
	      (cons (min beg (car diff-unhandled-changes))
892
		    (max end (cdr diff-unhandled-changes))))
893 894 895 896 897 898 899
      (setq diff-unhandled-changes (cons beg end)))))

(defun diff-post-command-hook ()
  "Fixup hunk headers if necessary."
  (when (consp diff-unhandled-changes)
    (ignore-errors
      (save-excursion
900
	(goto-char (car diff-unhandled-changes))
901 902
	;; Maybe we've cut the end of the hunk before point.
	(if (and (bolp) (not (bobp))) (backward-char 1))
903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
	;; We used to fixup modifs on all the changes, but it turns out
	;; that it's safer not to do it on big changes, for example
	;; when yanking a big diff, since we might then screw up perfectly
	;; correct values.  -stef
	;; (unless (ignore-errors
	;; 	  (diff-beginning-of-hunk)
	;; 	  (save-excursion
	;; 	    (diff-end-of-hunk)
	;; 	    (> (point) (car diff-unhandled-changes))))
	;;   (goto-char (car diff-unhandled-changes))
	;; (re-search-forward diff-hunk-header-re (cdr diff-unhandled-changes))
	;;   (diff-beginning-of-hunk))
	;; (diff-fixup-modifs (point) (cdr diff-unhandled-changes))
	(diff-beginning-of-hunk)
	(when (save-excursion
		(diff-end-of-hunk)
919
		(>= (point) (cdr diff-unhandled-changes)))
920
	  (diff-fixup-modifs (point) (cdr diff-unhandled-changes)))))
921 922
    (setq diff-unhandled-changes nil)))

Stefan Monnier's avatar
Stefan Monnier committed
923 924 925 926 927 928 929 930
(defun diff-next-error (arg reset)
  ;; Select a window that displays the current buffer so that point
  ;; movements are reflected in that window.  Otherwise, the user might
  ;; never see the hunk corresponding to the source she's jumping to.
  (pop-to-buffer (current-buffer))
  (if reset (goto-char (point-min)))
  (diff-hunk-next arg)
  (diff-goto-source))
931 932

;;;###autoload
933
(define-derived-mode diff-mode fundamental-mode "Diff"
934
  "Major mode for viewing/editing context diffs.
935 936
Supports unified and context diffs as well as (to a lesser extent)
normal diffs.
937
When the buffer is read-only, the ESC prefix is not necessary.
938
If you edit the buffer manually, diff-mode will try to update the hunk
939 940 941 942 943
headers for you on-the-fly.

You can also switch between context diff and unified diff with \\[diff-context->unified],
or vice versa with \\[diff-unified->context] and you can also revert the direction of
a diff with \\[diff-reverse-direction]."
944 945
  (set (make-local-variable 'font-lock-defaults) diff-font-lock-defaults)
  (set (make-local-variable 'outline-regexp) diff-outline-regexp)
946 947
  (set (make-local-variable 'imenu-generic-expression)
       diff-imenu-generic-expression)
948 949 950 951 952 953 954 955 956 957
  ;; These are not perfect.  They would be better done separately for
  ;; context diffs and unidiffs.
  ;; (set (make-local-variable 'paragraph-start)
  ;;        (concat "@@ "			; unidiff hunk
  ;; 	       "\\|\\*\\*\\* "		; context diff hunk or file start
  ;; 	       "\\|--- [^\t]+\t"))	; context or unidiff file
  ;; 					; start (first or second line)
  ;;   (set (make-local-variable 'paragraph-separate) paragraph-start)
  ;;   (set (make-local-variable 'page-delimiter) "--- [^\t]+\t")
  ;; compile support
Stefan Monnier's avatar
Stefan Monnier committed
958
  (set (make-local-variable 'next-error-function) 'diff-next-error)
959

960
  (when (and (> (point-max) (point-min)) diff-default-read-only)
961
    (toggle-read-only t))
962
  ;; setup change hooks
963
  (if (not diff-update-on-the-fly)
964
      (add-hook 'write-contents-functions 'diff-write-contents-hooks nil t)
965
    (make-local-variable 'diff-unhandled-changes)
966 967
    (add-hook 'after-change-functions 'diff-after-change-function nil t)
    (add-hook 'post-command-hook 'diff-post-command-hook nil t))
968
  ;; Neat trick from Dave Love to add more bindings in read-only mode:
969 970 971 972 973 974
  (let ((ro-bind (cons 'buffer-read-only diff-mode-shared-map)))
    (add-to-list 'minor-mode-overriding-map-alist ro-bind)
    ;; Turn off this little trick in case the buffer is put in view-mode.
    (add-hook 'view-mode-hook
	      `(lambda ()
		 (setq minor-mode-overriding-map-alist
975
		       (delq ',ro-bind minor-mode-overriding-map-alist)))
976
	      nil t))
977 978 979
  ;; add-log support
  (set (make-local-variable 'add-log-current-defun-function)
       'diff-current-defun)
980 981
  (set (make-local-variable 'add-log-buffer-file-name-function)
       'diff-find-file-name))
982 983

;;;###autoload
984 985 986
(define-minor-mode diff-minor-mode
  "Minor mode for viewing/editing context diffs.
\\{diff-minor-mode-map}"
987
  :group 'diff-mode :lighter " Diff"
988
  ;; FIXME: setup font-lock
989
  ;; setup change hooks
990
  (if (not diff-update-on-the-fly)
991
      (add-hook 'write-contents-functions 'diff-write-contents-hooks nil t)
992
    (make-local-variable 'diff-unhandled-changes)
993 994
    (add-hook 'after-change-functions 'diff-after-change-function nil t)
    (add-hook 'post-command-hook 'diff-post-command-hook nil t)))
995

996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
;;; Handy hook functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(defun diff-delete-if-empty ()
  ;; An empty diff file means there's no more diffs to integrate, so we
  ;; can just remove the file altogether.  Very handy for .rej files if we
  ;; remove hunks as we apply them.
  (when (and buffer-file-name
	     (eq 0 (nth 7 (file-attributes buffer-file-name))))
    (delete-file buffer-file-name)))

(defun diff-delete-empty-files ()
  "Arrange for empty diff files to be removed."
  (add-hook 'after-save-hook 'diff-delete-if-empty nil t))

(defun diff-make-unified ()
  "Turn context diffs into unified diffs if applicable."
  (if (save-excursion
	(goto-char (point-min))
1014
	(and (looking-at diff-hunk-header-re) (eq (char-after) ?*)))
1015 1016 1017 1018
      (let ((mod (bu