diff-mode.el 52.9 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
;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4
;;   2005, 2006 Free Software Foundation, Inc.
5

Stefan Monnier's avatar
Stefan Monnier committed
6
;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
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

;;; Code:

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

58 59
(defvar add-log-buffer-file-name-function)

60 61

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

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

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

78
(defcustom diff-update-on-the-fly t
79 80 81 82 83 84
  "*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)."
85 86
  :type 'boolean
  :group 'diff-mode)
87

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


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

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

103
;;;;
104
;;;; keymap, menu, ...
105
;;;;
106

107
(easy-mmode-defmap diff-mode-shared-map
108
  '(;; From Pavel Machek's patch-mode.
109 110 111 112 113 114
    ("n" . diff-hunk-next)
    ("N" . diff-file-next)
    ("p" . diff-hunk-prev)
    ("P" . diff-file-prev)
    ("k" . diff-hunk-kill)
    ("K" . diff-file-kill)
115
    ;; From compilation-minor-mode.
116 117
    ("}" . diff-file-next)
    ("{" . diff-file-prev)
118
    ("\C-m" . diff-goto-source)
119
    ([mouse-2] . diff-goto-source)
120
    ;; From XEmacs' diff-mode.
121 122
;; Standard M-w is useful, so don't change M-W.
;;    ("W" . widen)
123 124 125 126 127 128 129 130
    ;;("." . 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)
131 132 133 134 135 136 137 138
;; Not useful if you have to metafy them.
;;    (" " . scroll-up)
;;    ("\177" . scroll-down)
;; Standard M-a is useful, so don't change M-A.
;;    ("A" . diff-ediff-patch)
;; Standard M-r is useful, so don't change M-r or M-R.
;;    ("r" . diff-restrict-view)
;;    ("R" . diff-reverse-direction)
Benjamin Rutt's avatar
Benjamin Rutt committed
139
    ("q" . quit-window))
140
  "Basic keymap for `diff-mode', bound to various prefix keys.")
141

142
(easy-mmode-defmap diff-mode-map
143
  `(("\e" . ,diff-mode-shared-map)
144 145 146
    ;; From compilation-minor-mode.
    ("\C-c\C-c" . diff-goto-source)
    ;; Misc operations.
147
    ("\C-c\C-a" . diff-apply-hunk)
148 149 150 151
    ("\C-c\C-e" . diff-ediff-patch)
    ("\C-c\C-n" . diff-restrict-view)
    ("\C-c\C-r" . diff-reverse-direction)
    ("\C-c\C-s" . diff-split-hunk)
152
    ("\C-c\C-t" . diff-test-hunk)
153 154
    ("\C-c\C-u" . diff-context->unified)
    ("\C-c\C-w" . diff-refine-hunk)
155
    ("\C-c\C-f" . next-error-follow-minor-mode))
156 157 158 159 160 161
  "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]
162 163
    ["Apply hunk"		diff-apply-hunk		t]
    ["Apply diff with Ediff"	diff-ediff-patch	t]
164 165 166 167 168 169 170
    ["-----" 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)]
    ))

171
(defcustom diff-minor-mode-prefix "\C-c="
172
  "Prefix key for `diff-minor-mode' commands."
173 174
  :type '(choice (string "\e") (string "C-c=") string)
  :group 'diff-mode)
175

176 177
(easy-mmode-defmap diff-minor-mode-map
  `((,diff-minor-mode-prefix . ,diff-mode-shared-map))
178 179
  "Keymap for `diff-minor-mode'.  See also `diff-mode-shared-map'.")

180

181
;;;;
182
;;;; font-lock support
183
;;;;
184

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

201
(defface diff-file-header
202
  '((((class color) (min-colors 88) (background light))
203
     :background "grey70" :weight bold)
204
    (((class color) (min-colors 88) (background dark))
205
     :background "grey60" :weight bold)
206
    (((class color) (background light))
207
     :foreground "green" :weight bold)
208
    (((class color) (background dark))
209 210
     :foreground "cyan" :weight bold)
    (t :weight bold))			; :height 1.3
211 212
  "`diff-mode' face used to highlight file header lines."
  :group 'diff-mode)
213 214 215
;; backward-compatibility alias
(put 'diff-file-header-face 'face-alias 'diff-file-header)
(defvar diff-file-header-face 'diff-file-header)
216

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

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

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

241 242
(defface diff-added
  '((t :inherit diff-changed))
243 244
  "`diff-mode' face used to highlight added lines."
  :group 'diff-mode)
245 246 247
;; backward-compatibility alias
(put 'diff-added-face 'face-alias 'diff-added)
(defvar diff-added-face 'diff-added)
248

249
(defface diff-changed
250
  '((((type tty pc) (class color) (background light))
251
     :foreground "magenta" :weight bold :slant italic)
252
    (((type tty pc) (class color) (background dark))
253
     :foreground "yellow" :weight bold :slant italic))
254 255
  "`diff-mode' face used to highlight changed lines."
  :group 'diff-mode)
256 257 258
;; backward-compatibility alias
(put 'diff-changed-face 'face-alias 'diff-changed)
(defvar diff-changed-face 'diff-changed)
259

260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
(defface diff-indicator-removed
  '((t :inherit diff-removed))
  "`diff-mode' face used to highlight indicator of removed lines (-, <)."
  :group 'diff-mode
  :version "22.1")
(defvar diff-indicator-removed-face 'diff-indicator-removed)

(defface diff-indicator-added
  '((t :inherit diff-added))
  "`diff-mode' face used to highlight indicator of added lines (+, >)."
  :group 'diff-mode
  :version "22.1")
(defvar diff-indicator-added-face 'diff-indicator-added)

(defface diff-indicator-changed
  '((t :inherit diff-changed))
  "`diff-mode' face used to highlight indicator of changed lines."
  :group 'diff-mode
  :version "22.1")
(defvar diff-indicator-changed-face 'diff-indicator-changed)

281
(defface diff-function
282
  '((t :inherit diff-header))
283 284
  "`diff-mode' face used to highlight function names produced by \"diff -p\"."
  :group 'diff-mode)
285 286 287
;; backward-compatibility alias
(put 'diff-function-face 'face-alias 'diff-function)
(defvar diff-function-face 'diff-function)
288

289
(defface diff-context
290
  '((((class color grayscale) (min-colors 88)) :inherit shadow))
291 292
  "`diff-mode' face used to highlight context and other side-information."
  :group 'diff-mode)
293 294 295
;; backward-compatibility alias
(put 'diff-context-face 'face-alias 'diff-context)
(defvar diff-context-face 'diff-context)
Stefan Monnier's avatar
Stefan Monnier committed
296

297 298
(defface diff-nonexistent
  '((t :inherit diff-file-header))
299 300
  "`diff-mode' face used to highlight nonexistent files in recursive diffs."
  :group 'diff-mode)
301 302 303
;; backward-compatibility alias
(put 'diff-nonexistent-face 'face-alias 'diff-nonexistent)
(defvar diff-nonexistent-face 'diff-nonexistent)
304

305 306
(defconst diff-yank-handler '(diff-yank-function))
(defun diff-yank-function (text)
307 308 309
  ;; 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
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
  (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)))))))
326

327

328
(defvar diff-font-lock-keywords
329 330 331 332
  `(("^\\(@@ -[0-9,]+ \\+[0-9,]+ @@\\)\\(.*\\)$"          ;unified
     (1 diff-hunk-header-face) (2 diff-function-face))
    ("^\\(\\*\\{15\\}\\)\\(.*\\)$"                        ;context
     (1 diff-hunk-header-face) (2 diff-function-face))
333
    ("^\\*\\*\\* .+ \\*\\*\\*\\*". diff-hunk-header-face) ;context
334 335 336
    ("^--- .+ ----$"             . diff-hunk-header-face) ;context
    ("^[0-9,]+[acd][0-9,]+$"     . diff-hunk-header-face) ;normal
    ("^---$"                     . diff-hunk-header-face) ;normal
337
    ("^\\(---\\|\\+\\+\\+\\|\\*\\*\\*\\) \\(\\S-+\\)\\(.*[^*-]\\)?\n"
Stefan Monnier's avatar
Stefan Monnier committed
338
     (0 diff-header-face) (2 diff-file-header-face prepend))
339 340 341 342 343 344 345 346
    ("^\\([-<]\\)\\(.*\n\\)"
     (1 diff-indicator-removed-face) (2 diff-removed-face))
    ("^\\([+>]\\)\\(.*\n\\)"
     (1 diff-indicator-added-face) (2 diff-added-face))
    ("^\\(!\\)\\(.*\n\\)"
     (1 diff-indicator-changed-face) (2 diff-changed-face))
    ("^Index: \\(.+\\).*\n"
     (0 diff-header-face) (1 diff-index-face prepend))
347
    ("^Only in .*\n" . diff-nonexistent-face)
348
    ("^\\(#\\)\\(.*\\)"
349 350
     (1 font-lock-comment-delimiter-face)
     (2 font-lock-comment-face))
351
    ("^[^-=+*!<>#].*\n" (0 diff-context-face))))
352 353

(defconst diff-font-lock-defaults
354
  '(diff-font-lock-keywords t nil nil nil (font-lock-multiline . nil)))
355

356 357
(defvar diff-imenu-generic-expression
  ;; Prefer second name as first is most likely to be a backup or
358 359 360
  ;; 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
361 362
    (nil "^--- \\([^\t\n]+\\)\t.*\n\\*" 1))) ; context diffs

363
;;;;
364
;;;; Movement
365
;;;;
366

367
(defconst diff-hunk-header-re "^\\(@@ -[0-9,]+ \\+[0-9,]+ @@.*\\|\\*\\{15\\}.*\n\\*\\*\\* .+ \\*\\*\\*\\*\\|[0-9]+\\(,[0-9]+\\)?[acd][0-9]+\\(,[0-9]+\\)?\\)$")
368
(defconst diff-file-header-re (concat "^\\(--- .+\n\\+\\+\\+ \\|\\*\\*\\* .+\n--- \\|[^-+!<>0-9@* ]\\).+\n" (substring diff-hunk-header-re 1)))
369 370 371
(defvar diff-narrowed-to nil)

(defun diff-end-of-hunk (&optional style)
372 373 374 375 376
  (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)))
377
  (let ((end (and (re-search-forward (case style
378 379 380
				       ;; A `unified' header is ambiguous.
				       (unified (concat "^[^-+# \\]\\|"
							diff-file-header-re))
381 382 383 384 385 386 387
				       (context "^[^-+#! \\]")
				       (normal "^[^<>#\\]")
				       (t "^[^-+#!<> \\]"))
				     nil t)
		  (match-beginning 0))))
    ;; The return value is used by easy-mmode-define-navigation.
    (goto-char (or end (point-max)))))
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405

(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 ()
406
  (re-search-forward "^[-+#!<>0-9@* \\]" nil t)
407 408 409 410 411
  (re-search-forward (concat "^[^-+#!<>0-9@* \\]\\|" diff-file-header-re)
		     nil 'move)
  (if (match-beginning 1)
      (goto-char (match-beginning 1))
    (beginning-of-line)))
412

413 414
;; Define diff-{hunk,file}-{prev,next}
(easy-mmode-define-navigation
415
 diff-hunk diff-hunk-header-re "hunk" diff-end-of-hunk diff-restrict-view)
416 417
(easy-mmode-define-navigation
 diff-file diff-file-header-re "file" diff-end-of-hunk)
418 419 420 421 422 423 424 425 426 427 428 429 430

(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))))


431
(defun diff-hunk-kill ()
432 433 434
  "Kill current hunk."
  (interactive)
  (diff-beginning-of-hunk)
435
  (let* ((start (point))
436 437
	 (nexthunk (when (re-search-forward diff-hunk-header-re nil t)
		     (match-beginning 0)))
438 439 440
	 (firsthunk (ignore-errors
		      (goto-char start)
		      (diff-beginning-of-file) (diff-hunk-next) (point)))
441 442
	 (nextfile (ignore-errors (diff-file-next) (point)))
	 (inhibit-read-only t))
443
    (goto-char start)
444 445 446
    (if (and firsthunk (= firsthunk start)
	     (or (null nexthunk)
		 (and nextfile (> nexthunk nextfile))))
447
	;; It's the only hunk for this file, so kill the file.
448
	(diff-file-kill)
449 450 451
      (diff-end-of-hunk)
      (kill-region start (point)))))

452
(defun diff-file-kill ()
453 454 455 456 457 458
  "Kill current file's hunks."
  (interactive)
  (diff-beginning-of-file)
  (let* ((start (point))
	 (prevhunk (save-excursion
		     (ignore-errors
459
		       (diff-hunk-prev) (point))))
460
	 (index (save-excursion
461 462
		  (re-search-backward "^Index: " prevhunk t)))
	 (inhibit-read-only t))
463 464
    (when index (setq start index))
    (diff-end-of-file)
465
    (if (looking-at "^\n") (forward-char 1)) ;`tla' generates such diffs.
466 467
    (kill-region start (point))))

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
(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)))))

483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
(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)))
502 503
	   (newstart2 (+ start2 (diff-count-matches "^[+ \t]" (point) pos)))
	   (inhibit-read-only t))
504 505 506 507 508 509
      (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))))
510

511

512 513 514 515
;;;;
;;;; jump to other buffers
;;;;

516 517
(defvar diff-remembered-files-alist nil)

518 519 520
(defun diff-filename-drop-dir (file)
  (when (string-match "/" file) (substring file (match-end 0))))

521 522 523
(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.
524
The strings are assumed not to contain any \"\\n\" (i.e. end of line).
525 526 527 528 529 530 531 532
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
533
  (let ((str (concat ancestor "\n" from "\n" to)))
534
    (when (and (string-match (concat
535 536
			      "\\`\\(.*?\\)\\(.*\\)\\(.*\\)\n"
			      "\\1\\(.*\\)\\3\n"
537 538 539 540 541 542
			      "\\(.*\\(\\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))))))

543 544 545 546 547 548 549 550 551 552 553 554
(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)))
555

556 557
(defun diff-hunk-file-names (&optional old)
  "Give the list of file names textually mentioned for the current hunk."
558 559 560 561
  (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)))
562
    (let ((limit (save-excursion
563
		   (condition-case ()
564
		       (progn (diff-hunk-prev) (point))
565
		     (error (point-min)))))
566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591
	  (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)))
592
      (or
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609
       ;; 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>
610 611 612
       (and (string-match "\\.rej\\'" (or buffer-file-name ""))
	    (let ((file (substring buffer-file-name 0 (match-beginning 0))))
	      (when (file-exists-p file) file)))
613 614 615 616 617
       ;; 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))
618 619
	 file)))))

620

621 622 623 624
(defun diff-ediff-patch ()
  "Call `ediff-patch-file' on the current buffer."
  (interactive)
  (condition-case err
625
      (ediff-patch-file nil (current-buffer))
626 627
    (wrong-number-of-arguments (ediff-patch-file))))

628
;;;;
629
;;;; Conversion functions
630
;;;;
631 632 633 634 635 636 637 638

;;(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."
639 640
  (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
		   (list (region-beginning) (region-end))
641 642 643 644 645 646
		 (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)
647
      (while (and (re-search-forward "^\\(\\(---\\) .+\n\\(\\+\\+\\+\\) .+\\|@@ -\\([0-9]+\\),\\([0-9]+\\) \\+\\([0-9]+\\),\\([0-9]+\\) @@.*\\)$" nil t)
648 649 650
		  (< (point) end))
	(combine-after-change-calls
	  (if (match-beginning 2)
651
	      ;; we matched a file header
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
	      (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
679
			  (?\s (insert " ") (setq modif nil) (backward-char 1))
680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703
			  (?+ (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
704
			  (?\s (insert " ") (setq modif nil) (backward-char 1))
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
			  (?- (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)))))))))))))))

722
(defun diff-context->unified (start end &optional to-context)
723
  "Convert context diffs to unified diffs.
724 725 726 727
START and END are either taken from the region
\(when it is highlighted) or else cover the whole buffer.
With a prefix argument, convert unified format to context format."
  (interactive (if (and transient-mark-mode mark-active)
728
		   (list (region-beginning) (region-end) current-prefix-arg)
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
		 (list (point-min) (point-max) current-prefix-arg)))
  (if to-context
      (diff-unified->context start end)
    (unless (markerp end) (setq end (copy-marker end)))
    (let ( ;;(diff-inhibit-after-change t)
	  (inhibit-read-only t))
      (save-excursion
	(goto-char start)
	(while (and (re-search-forward "^\\(\\(\\*\\*\\*\\) .+\n\\(---\\) .+\\|\\*\\{15\\}.*\n\\*\\*\\* \\([0-9]+\\),\\(-?[0-9]+\\) \\*\\*\\*\\*\\)$" nil t)
		    (< (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))))
760
		  (goto-char pt1)
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795
		  (forward-line 1)
		  (while (< (point) pt2)
		    (case (char-after)
		      ((?! ?-) (delete-char 2) (insert "-") (forward-line 1))
		      (?\s     ;merge with the other half of the chunk
		       (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))))
			   (?\s		;FIXME: check consistency
			    (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)) " @@")))))))))))
796 797 798 799 800

(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."
801 802
  (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
		   (list (region-beginning) (region-end))
803 804 805 806 807 808
		 (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)
809
      (while (and (re-search-forward "^\\(\\([-*][-*][-*] \\)\\(.+\\)\n\\([-+][-+][-+] \\)\\(.+\\)\\|\\*\\{15\\}.*\n\\*\\*\\* \\(.+\\) \\*\\*\\*\\*\\|@@ -\\([0-9,]+\\) \\+\\([0-9,]+\\) @@.*\\)$" nil t)
810 811 812 813 814 815 816 817 818 819 820 821
		  (< (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)))
822
		(while (looking-at "[-! \\][ \t]\\|#")
823 824
		  (when (= (char-after) ?-) (delete-char 1) (insert "+"))
		  (forward-line 1))
825
		(let ((half1 (delete-and-extract-region half1s (point))))
826 827 828 829 830 831 832
		  (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)))
833
		      (while (looking-at "[!+ \\][ \t]\\|#")
834 835
			(when (= (char-after) ?+) (delete-char 1) (insert "-"))
			(forward-line 1))
836
		      (let ((half2 (delete-and-extract-region half2s (point))))
837
			(insert (or half1 ""))
838
			(goto-char half1s)
839
			(insert (or half2 ""))))
840 841 842 843 844 845 846 847 848 849 850 851
		    (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)
852
		       ((?\\ ?#) t)
853
		       (t (when (and first last (< first last))
854
			    (insert (delete-and-extract-region first last)))
855
			  (setq first nil last nil)
856
			  (equal ?\s c)))
857 858 859 860 861 862
		(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."
863 864
  (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
		   (list (region-beginning) (region-end))
865 866 867 868 869 870
		 (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)))
871 872 873 874
	  (if (not (looking-at
		    (concat "@@ -[0-9,]+ \\+[0-9,]+ @@"
			    "\\|[-*][-*][-*] [0-9,]+ [-*][-*][-*][-*]$"
			    "\\|--- .+\n\\+\\+\\+ ")))
875
	      (case (char-after)
876
		(?\s (incf space))
877 878 879
		(?+ (incf plus))
		(?- (incf minus))
		(?! (incf bang))
880
		((?\\ ?#) nil)
881 882
		(t  (setq space 0 plus 0 minus 0 bang 0)))
	    (cond
883
	     ((looking-at "@@ -[0-9]+,\\([0-9]*\\) \\+[0-9]+,\\([0-9]*\\) @@.*$")
884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905
	      (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)))))))

906
;;;;
907
;;;; Hooks
908
;;;;
909 910 911 912 913 914 915 916 917 918 919 920 921

(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."
922 923 924 925 926
  ;; 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.
927 928 929 930
  (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))
931
		    (max end (cdr diff-unhandled-changes))))
932 933 934 935 936 937 938
      (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
939
	(goto-char (car diff-unhandled-changes))
940 941
	;; Maybe we've cut the end of the hunk before point.
	(if (and (bolp) (not (bobp))) (backward-char 1))
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957
	;; 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)
958
		(>= (point) (cdr diff-unhandled-changes)))
959
	  (diff-fixup-modifs (point) (cdr diff-unhandled-changes)))))
960 961
    (setq diff-unhandled-changes nil)))

Stefan Monnier's avatar
Stefan Monnier committed
962 963 964 965 966 967 968 969
(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))
970 971

;;;###autoload
972
(define-derived-mode diff-mode fundamental-mode "Diff"
973
  "Major mode for viewing/editing context diffs.
974 975
Supports unified and context diffs as well as (to a lesser extent)
normal diffs.
976
When the buffer is read-only, the ESC prefix is not necessary.
977
If you edit the buffer manually, diff-mode will try to update the hunk
978 979 980
headers for you on-the-fly.

You can also switch between context diff and unified diff with \\[diff-context->unified],
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
981
or vice versa with \\[diff-unified->context] and you can also reverse the direction of
982
a diff with \\[diff-reverse-direction]."
983 984
  (set (make-local-variable 'font-lock-defaults) diff-font-lock-defaults)
  (set (make-local-variable 'outline-regexp) diff-outline-regexp)
985 986
  (set (make-local-variable 'imenu-generic-expression)
       diff-imenu-generic-expression)
987 988 989 990 991 992 993 994 995 996
  ;; 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
997
  (set (make-local-variable 'next-error-function) 'diff-next-error)
998

999
  (setq buffer-read-only diff-default-read-only)
1000
  ;; setup change hooks
1001
  (if (not diff-update-on-the-fly)
1002
      (add-hook 'write-contents-functions 'diff-write-contents-hooks nil t)
1003
    (make-local-variable 'diff-unhandled-changes)
1004 1005
    (add-hook 'after-change-functions 'diff-after-change-function nil t)
    (add-hook 'post-command-hook 'diff-post-command-hook nil t))
1006
  ;; Neat trick from Dave Love to add more bindings in read-only mode:
1007 1008 1009 1010 1011 1012
  (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
1013
		       (delq ',ro-bind minor-mode-overriding-map-alist)))
1014
	      nil t))