diff-mode.el 63.8 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,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2005, 2006, 2007, 2008 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

;; 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
13
;; the Free Software Foundation; either version 3, or (at your option)
14 15 16 17 18 19 20 21 22
;; 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
;; - 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".
49
;;   Maybe just use `wiggle' (by Neil Brown) to do it for us.
50 51
;;
;; - Refine hunk on a word-by-word basis.
52 53 54
;; 
;; - in diff-apply-hunk, strip context in replace-match to better
;;   preserve markers and spacing.
55
;; - Handle `diff -b' output in context->unified.
56 57 58 59

;;; Code:
(eval-when-compile (require 'cl))

60 61
(defvar add-log-buffer-file-name-function)

62 63

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

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

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

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

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


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

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

105
;;;;
106
;;;; keymap, menu, ...
107
;;;;
108

109
(easy-mmode-defmap diff-mode-shared-map
110
  '(;; From Pavel Machek's patch-mode.
111 112 113 114
    ("n" . diff-hunk-next)
    ("N" . diff-file-next)
    ("p" . diff-hunk-prev)
    ("P" . diff-file-prev)
115 116
    ("\t" . diff-hunk-next)
    ([backtab] . diff-hunk-prev)
117 118
    ("k" . diff-hunk-kill)
    ("K" . diff-file-kill)
119
    ;; From compilation-minor-mode.
120 121
    ("}" . diff-file-next)
    ("{" . diff-file-prev)
122
    ("\C-m" . diff-goto-source)
123
    ([mouse-2] . diff-goto-source)
124
    ;; From XEmacs' diff-mode.
125 126
    ;; Standard M-w is useful, so don't change M-W.
    ;;("W" . widen)
127 128 129 130 131 132 133 134
    ;;("." . 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)
135 136 137 138 139 140 141 142
    ;; 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
143
    ("q" . quit-window))
144
  "Basic keymap for `diff-mode', bound to various prefix keys.")
145

146
(easy-mmode-defmap diff-mode-map
147
  `(("\e" . ,diff-mode-shared-map)
148 149 150
    ;; From compilation-minor-mode.
    ("\C-c\C-c" . diff-goto-source)
    ;; Misc operations.
151
    ("\C-c\C-a" . diff-apply-hunk)
152 153 154 155
    ("\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)
156
    ("\C-c\C-t" . diff-test-hunk)
157
    ("\C-c\C-u" . diff-context->unified)
158 159
    ;; `d' because it duplicates the context :-(  --Stef
    ("\C-c\C-d" . diff-unified->context)
160
    ("\C-c\C-w" . diff-refine-hunk)
161
    ("\C-c\C-f" . next-error-follow-minor-mode))
162 163 164 165 166 167
  "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]
168
    ["Apply hunk"		diff-apply-hunk		t]
169
    ["Test applying hunk"	diff-test-hunk		t]
170
    ["Apply diff with Ediff"	diff-ediff-patch	t]
171
    "-----"
172 173 174 175
    ["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)]
176 177 178 179 180 181 182 183 184 185
    "-----"
    ["Split hunk"		diff-split-hunk		t]
    ["Refine hunk"	        diff-refine-hunk	t]
    ["Kill current hunk"	diff-hunk-kill   	t]
    ["Kill current file's hunks" diff-file-kill   	t]
    "-----"
    ["Previous Hunk"		diff-hunk-prev  	t]
    ["Next Hunk"		diff-hunk-next  	t]
    ["Previous File"		diff-file-prev  	t]
    ["Next File"		diff-file-next  	t]
186 187
    ))

188
(defcustom diff-minor-mode-prefix "\C-c="
189
  "Prefix key for `diff-minor-mode' commands."
190 191
  :type '(choice (string "\e") (string "C-c=") string)
  :group 'diff-mode)
192

193 194
(easy-mmode-defmap diff-minor-mode-map
  `((,diff-minor-mode-prefix . ,diff-mode-shared-map))
195 196
  "Keymap for `diff-minor-mode'.  See also `diff-mode-shared-map'.")

197

198
;;;;
199
;;;; font-lock support
200
;;;;
201

202
(defface diff-header
203
  '((((class color) (min-colors 88) (background light))
204
     :background "grey85")
205
    (((class color) (min-colors 88) (background dark))
206
     :background "grey45")
207
    (((class color) (background light))
208
     :foreground "blue1" :weight bold)
209
    (((class color) (background dark))
210 211
     :foreground "green" :weight bold)
    (t :weight bold))
212 213
  "`diff-mode' face inherited by hunk and index header faces."
  :group 'diff-mode)
214 215 216
;; backward-compatibility alias
(put 'diff-header-face 'face-alias 'diff-header)
(defvar diff-header-face 'diff-header)
Stefan Monnier's avatar
Stefan Monnier committed
217

218
(defface diff-file-header
219
  '((((class color) (min-colors 88) (background light))
220
     :background "grey70" :weight bold)
221
    (((class color) (min-colors 88) (background dark))
222
     :background "grey60" :weight bold)
223
    (((class color) (background light))
224
     :foreground "green" :weight bold)
225
    (((class color) (background dark))
226 227
     :foreground "cyan" :weight bold)
    (t :weight bold))			; :height 1.3
228 229
  "`diff-mode' face used to highlight file header lines."
  :group 'diff-mode)
230 231 232
;; backward-compatibility alias
(put 'diff-file-header-face 'face-alias 'diff-file-header)
(defvar diff-file-header-face 'diff-file-header)
233

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

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

250 251
(defface diff-removed
  '((t :inherit diff-changed))
252 253
  "`diff-mode' face used to highlight removed lines."
  :group 'diff-mode)
254 255 256
;; backward-compatibility alias
(put 'diff-removed-face 'face-alias 'diff-removed)
(defvar diff-removed-face 'diff-removed)
257

258 259
(defface diff-added
  '((t :inherit diff-changed))
260 261
  "`diff-mode' face used to highlight added lines."
  :group 'diff-mode)
262 263 264
;; backward-compatibility alias
(put 'diff-added-face 'face-alias 'diff-added)
(defvar diff-added-face 'diff-added)
265

266
(defface diff-changed
267
  '((((type tty pc) (class color) (background light))
268
     :foreground "magenta" :weight bold :slant italic)
269
    (((type tty pc) (class color) (background dark))
270
     :foreground "yellow" :weight bold :slant italic))
271 272
  "`diff-mode' face used to highlight changed lines."
  :group 'diff-mode)
273 274 275
;; backward-compatibility alias
(put 'diff-changed-face 'face-alias 'diff-changed)
(defvar diff-changed-face 'diff-changed)
276

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
(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)

298
(defface diff-function
299
  '((t :inherit diff-header))
300 301
  "`diff-mode' face used to highlight function names produced by \"diff -p\"."
  :group 'diff-mode)
302 303 304
;; backward-compatibility alias
(put 'diff-function-face 'face-alias 'diff-function)
(defvar diff-function-face 'diff-function)
305

306
(defface diff-context
307
  '((((class color grayscale) (min-colors 88)) :inherit shadow))
308 309
  "`diff-mode' face used to highlight context and other side-information."
  :group 'diff-mode)
310 311 312
;; backward-compatibility alias
(put 'diff-context-face 'face-alias 'diff-context)
(defvar diff-context-face 'diff-context)
Stefan Monnier's avatar
Stefan Monnier committed
313

314 315
(defface diff-nonexistent
  '((t :inherit diff-file-header))
316 317
  "`diff-mode' face used to highlight nonexistent files in recursive diffs."
  :group 'diff-mode)
318 319 320
;; backward-compatibility alias
(put 'diff-nonexistent-face 'face-alias 'diff-nonexistent)
(defvar diff-nonexistent-face 'diff-nonexistent)
321

322 323
(defconst diff-yank-handler '(diff-yank-function))
(defun diff-yank-function (text)
324 325 326
  ;; 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
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
  (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)))))))
343

344 345
(defconst diff-hunk-header-re-unified
  "^@@ -\\([0-9]+\\),\\([0-9]+\\) \\+\\([0-9]+\\),\\([0-9]+\\) @@")
346

347
(defvar diff-font-lock-keywords
348 349
  `((,(concat "\\(" diff-hunk-header-re-unified "\\)\\(.*\\)$")
     (1 diff-hunk-header-face) (6 diff-function-face))
350 351
    ("^\\(\\*\\{15\\}\\)\\(.*\\)$"                        ;context
     (1 diff-hunk-header-face) (2 diff-function-face))
352
    ("^\\*\\*\\* .+ \\*\\*\\*\\*". diff-hunk-header-face) ;context
353 354 355
    ("^--- .+ ----$"             . diff-hunk-header-face) ;context
    ("^[0-9,]+[acd][0-9,]+$"     . diff-hunk-header-face) ;normal
    ("^---$"                     . diff-hunk-header-face) ;normal
356
    ("^\\(---\\|\\+\\+\\+\\|\\*\\*\\*\\) \\(\\S-+\\)\\(.*[^*-]\\)?\n"
Stefan Monnier's avatar
Stefan Monnier committed
357
     (0 diff-header-face) (2 diff-file-header-face prepend))
358 359 360 361 362 363 364 365
    ("^\\([-<]\\)\\(.*\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))
366
    ("^Only in .*\n" . diff-nonexistent-face)
367
    ("^\\(#\\)\\(.*\\)"
368 369
     (1 font-lock-comment-delimiter-face)
     (2 font-lock-comment-face))
370
    ("^[^-=+*!<>#].*\n" (0 diff-context-face))))
371 372

(defconst diff-font-lock-defaults
373
  '(diff-font-lock-keywords t nil nil nil (font-lock-multiline . nil)))
374

375 376
(defvar diff-imenu-generic-expression
  ;; Prefer second name as first is most likely to be a backup or
377 378 379
  ;; 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
380 381
    (nil "^--- \\([^\t\n]+\\)\t.*\n\\*" 1))) ; context diffs

382
;;;;
383
;;;; Movement
384
;;;;
385

386 387 388 389 390 391 392 393
(defvar diff-valid-unified-empty-line t
  "If non-nil, empty lines are valid in unified diffs.
Some versions of diff replace all-blank context lines in unified format with
empty lines.  This makes the format less robust, but is tolerated.
See http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01990.html")

(defconst diff-hunk-header-re
  (concat "^\\(?:" diff-hunk-header-re-unified ".*\\|\\*\\{15\\}.*\n\\*\\*\\* .+ \\*\\*\\*\\*\\|[0-9]+\\(,[0-9]+\\)?[acd][0-9]+\\(,[0-9]+\\)?\\)$"))
394
(defconst diff-file-header-re (concat "^\\(--- .+\n\\+\\+\\+ \\|\\*\\*\\* .+\n--- \\|[^-+!<>0-9@* ]\\).+\n" (substring diff-hunk-header-re 1)))
395 396
(defvar diff-narrowed-to nil)

397 398 399 400 401 402 403 404
(defun diff-end-of-hunk (&optional style donttrustheader)
  (let (end)
    (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))
      (when (and (not donttrustheader) (match-end 2))
405 406 407
        (let* ((nold (string-to-number (match-string 2)))
               (nnew (string-to-number (match-string 4)))
               (endold
408 409 410
        (save-excursion
          (re-search-forward (if diff-valid-unified-empty-line
                                 "^[- \n]" "^[- ]")
411 412 413 414 415 416 417 418 419 420 421
                                     nil t nold)
                  (line-beginning-position 2)))
               (endnew
                ;; The hunk may end with a bunch of "+" lines, so the `end' is
                ;; then further than computed above.
                (save-excursion
                  (re-search-forward (if diff-valid-unified-empty-line
                                         "^[+ \n]" "^[+ ]")
                                     nil t nnew)
                  (line-beginning-position 2))))
          (setq end (max endold endnew)))))
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441
    ;; We may have a first evaluation of `end' thanks to the hunk header.
    (unless end
      (setq end (and (re-search-forward
                      (case style
                        (unified (concat (if diff-valid-unified-empty-line
                                             "^[^-+# \\\n]\\|" "^[^-+# \\]\\|")
                                         ;; A `unified' header is ambiguous.
                                         diff-file-header-re))
                        (context "^[^-+#! \\]")
                        (normal "^[^<>#\\]")
                        (t "^[^-+#!<> \\]"))
                      nil t)
                     (match-beginning 0)))
      (when diff-valid-unified-empty-line
        ;; While empty lines may be valid inside hunks, they are also likely
        ;; to be unrelated to the hunk.
        (goto-char (or end (point-max)))
        (while (eq ?\n (char-before (1- (point))))
          (forward-char -1)
          (setq end (point)))))
442 443
    ;; The return value is used by easy-mmode-define-navigation.
    (goto-char (or end (point-max)))))
444

445 446 447 448
(defun diff-beginning-of-hunk (&optional try-harder)
  "Move back to beginning of hunk.
If TRY-HARDER is non-nil, try to cater to the case where we're not in a hunk
but in the file header instead, in which case move forward to the first hunk."
449 450 451 452 453
  (beginning-of-line)
  (unless (looking-at diff-hunk-header-re)
    (forward-line 1)
    (condition-case ()
	(re-search-backward diff-hunk-header-re)
454 455 456 457 458
      (error
       (if (not try-harder)
           (error "Can't find the beginning of the hunk")
         (diff-beginning-of-file-and-junk)
         (diff-hunk-next))))))
459 460 461 462 463 464 465 466 467 468

(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 ()
469
  (re-search-forward "^[-+#!<>0-9@* \\]" nil t)
470 471 472 473 474
  (re-search-forward (concat "^[^-+#!<>0-9@* \\]\\|" diff-file-header-re)
		     nil 'move)
  (if (match-beginning 1)
      (goto-char (match-beginning 1))
    (beginning-of-line)))
475

476 477
;; Define diff-{hunk,file}-{prev,next}
(easy-mmode-define-navigation
478
 diff-hunk diff-hunk-header-re "hunk" diff-end-of-hunk diff-restrict-view)
479 480
(easy-mmode-define-navigation
 diff-file diff-file-header-re "file" diff-end-of-hunk)
481 482 483 484 485 486

(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
487
    (if arg (diff-beginning-of-file) (diff-beginning-of-hunk 'try-harder))
488 489 490 491 492 493
    (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))))


494
(defun diff-hunk-kill ()
495 496 497
  "Kill current hunk."
  (interactive)
  (diff-beginning-of-hunk)
498
  (let* ((start (point))
499 500
	 (nexthunk (when (re-search-forward diff-hunk-header-re nil t)
		     (match-beginning 0)))
501 502 503
	 (firsthunk (ignore-errors
		      (goto-char start)
		      (diff-beginning-of-file) (diff-hunk-next) (point)))
504 505
	 (nextfile (ignore-errors (diff-file-next) (point)))
	 (inhibit-read-only t))
506
    (goto-char start)
507 508 509
    (if (and firsthunk (= firsthunk start)
	     (or (null nexthunk)
		 (and nextfile (> nexthunk nextfile))))
510
	;; It's the only hunk for this file, so kill the file.
511
	(diff-file-kill)
512 513 514
      (diff-end-of-hunk)
      (kill-region start (point)))))

515 516
(defconst diff-file-junk-re "diff \\|index ") ; "index " is output by git-diff.

517 518 519 520
(defun diff-beginning-of-file-and-junk ()
  "Go to the beginning of file-related diff-info.
This is like `diff-beginning-of-file' except it tries to skip back over leading
data such as \"Index: ...\" and such."
521 522 523 524 525 526 527
  (let ((orig (point))
        ;; Skip forward over what might be "leading junk" so as to get
        ;; closer to the actual diff.
        (_ (progn (beginning-of-line)
                  (while (looking-at diff-file-junk-re)
                    (forward-line 1))))
        (start (point))
528 529 530 531 532 533 534 535 536 537 538
        (file (condition-case err (progn (diff-beginning-of-file) (point))
                (error err)))
        ;; prevhunk is one of the limits.
        (prevhunk (save-excursion (ignore-errors (diff-hunk-prev) (point))))
        err)
    (when (consp file)
      ;; Presumably, we started before the file header, in the leading junk.
      (setq err file)
      (diff-file-next)
      (setq file (point)))
    (let ((index (save-excursion
539
                   (forward-line 1)  ;In case we're looking at "Index:".
540 541 542
                   (re-search-backward "^Index: " prevhunk t))))
      (when index (setq file index))
      (if (<= file start)
543 544 545 546 547 548 549 550
          (progn
            (goto-char file)
            ;; Now skip backward over the leading junk we may have before the
            ;; diff itself.
            (while (save-excursion
                     (and (zerop (forward-line -1))
                          (looking-at diff-file-junk-re)))
              (forward-line -1)))
551 552
        ;; File starts *after* the starting point: we really weren't in
        ;; a file diff but elsewhere.
553
        (goto-char orig)
554 555
        (signal (car err) (cdr err))))))
          
556
(defun diff-file-kill ()
557 558
  "Kill current file's hunks."
  (interactive)
559 560
  (let ((orig (point))
        (start (progn (diff-beginning-of-file-and-junk) (point)))
561
	 (inhibit-read-only t))
562
    (diff-end-of-file)
563
    (if (looking-at "^\n") (forward-char 1)) ;`tla' generates such diffs.
564
    (if (> orig (point)) (error "Not inside a file diff"))
565 566
    (kill-region start (point))))

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
(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)))))

582 583 584 585 586 587 588 589 590 591 592 593 594
(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))))
595
    (unless (looking-at diff-hunk-header-re-unified)
596 597 598
      (error "diff-split-hunk only works on unified context diffs"))
    (forward-line 1)
    (let* ((start1 (string-to-number (match-string 1)))
599
	   (start2 (string-to-number (match-string 3)))
600
	   (newstart1 (+ start1 (diff-count-matches "^[- \t]" (point) pos)))
601 602
	   (newstart2 (+ start2 (diff-count-matches "^[+ \t]" (point) pos)))
	   (inhibit-read-only t))
603 604 605 606 607 608
      (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))))
609

610

611 612 613 614
;;;;
;;;; jump to other buffers
;;;;

615 616
(defvar diff-remembered-files-alist nil)

617 618 619
(defun diff-filename-drop-dir (file)
  (when (string-match "/" file) (substring file (match-end 0))))

620 621 622
(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.
623
The strings are assumed not to contain any \"\\n\" (i.e. end of line).
624 625 626 627 628 629 630 631
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
632
  (let ((str (concat ancestor "\n" from "\n" to)))
633
    (when (and (string-match (concat
634 635
			      "\\`\\(.*?\\)\\(.*\\)\\(.*\\)\n"
			      "\\1\\(.*\\)\\3\n"
636 637 638 639 640 641
			      "\\(.*\\(\\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))))))

642 643 644 645 646 647 648 649 650 651 652 653
(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)))
654

655 656
(defun diff-hunk-file-names (&optional old)
  "Give the list of file names textually mentioned for the current hunk."
657 658 659 660
  (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)))
661
    (let ((limit (save-excursion
662
		   (condition-case ()
663
		       (progn (diff-hunk-prev) (point))
664
		     (error (point-min)))))
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682
	  (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)))))))))

683
(defun diff-find-file-name (&optional old prefix)
684
  "Return the file corresponding to the current patch.
685 686
Non-nil OLD means that we want the old file.
PREFIX is only used internally: don't use it."
687 688 689 690 691
  (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)))
692
      (if prefix (setq fs (mapcar (lambda (f) (concat prefix f)) fs)))
693
      (or
694 695 696 697 698 699 700 701 702 703 704 705 706
       ;; 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)))
707 708 709
			       ;; Use file-regular-p to avoid
			       ;; /dev/null, directories, etc.
			       ((or (null file) (file-regular-p file))
710 711 712
				file))))
	    file))
       ;; <foo>.rej patches implicitly apply to <foo>
713 714 715
       (and (string-match "\\.rej\\'" (or buffer-file-name ""))
	    (let ((file (substring buffer-file-name 0 (match-beginning 0))))
	      (when (file-exists-p file) file)))
716 717 718 719 720 721 722
       ;; If we haven't found the file, maybe it's because we haven't paid
       ;; attention to the PCL-CVS hint.
       (and (not prefix)
	    (boundp 'cvs-pcl-cvs-dirchange-re)
	    (save-excursion
	      (re-search-backward cvs-pcl-cvs-dirchange-re nil t))
	    (diff-find-file-name old (match-string 1)))
723 724 725 726 727
       ;; 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))
728 729
	 file)))))

730

731 732 733 734
(defun diff-ediff-patch ()
  "Call `ediff-patch-file' on the current buffer."
  (interactive)
  (condition-case err
735
      (ediff-patch-file nil (current-buffer))
736 737
    (wrong-number-of-arguments (ediff-patch-file))))

738
;;;;
739
;;;; Conversion functions
740
;;;;
741 742 743 744 745 746 747

;;(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
748
else cover the whole buffer."
749 750
  (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
		   (list (region-beginning) (region-end))
751
		 (list (point-min) (point-max))))
752
  (unless (markerp end) (setq end (copy-marker end t)))
753 754 755 756
  (let (;;(diff-inhibit-after-change t)
	(inhibit-read-only t))
    (save-excursion
      (goto-char start)
757 758 759 760
      (while (and (re-search-forward
                   (concat "^\\(\\(---\\) .+\n\\(\\+\\+\\+\\) .+\\|"
                           diff-hunk-header-re-unified ".*\\)$")
                   nil t)
761 762 763
		  (< (point) end))
	(combine-after-change-calls
	  (if (match-beginning 2)
764
	      ;; we matched a file header
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779
	      (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)) " ****"))
	      (save-restriction
780 781 782 783
		(narrow-to-region (line-beginning-position 2)
                                  ;; Call diff-end-of-hunk from just before
                                  ;; the hunk header so it can use the hunk
                                  ;; header info.
784 785 786 787 788 789 790 791 792 793
				  (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
794
			  (?\s (insert " ") (setq modif nil) (backward-char 1))
795 796 797 798 799 800 801 802 803 804
			  (?+ (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)))
805 806
                          ;; diff-valid-unified-empty-line.
                          (?\n (insert "  ") (setq modif nil) (backward-char 2))
807 808 809 810 811 812 813 814 815 816 817 818 819 820
			  (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
821
			  (?\s (insert " ") (setq modif nil) (backward-char 1))
822 823 824 825 826 827 828 829 830 831
			  (?- (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)))
832 833
                          ;; diff-valid-unified-empty-line.
                          (?\n (insert "  ") (setq modif nil) (backward-char 2))
834 835 836 837 838 839 840
			  (t (setq modif nil)))
			(let ((last-pt (point)))
			  (forward-line 1)
			  (when delete
			    (delete-region last-pt (point))
			    (setq delete nil)))))))))))))))

841
(defun diff-context->unified (start end &optional to-context)
842
  "Convert context diffs to unified diffs.
843 844 845 846
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)
847
		   (list (region-beginning) (region-end) current-prefix-arg)
848 849 850
		 (list (point-min) (point-max) current-prefix-arg)))
  (if to-context
      (diff-unified->context start end)
851
    (unless (markerp end) (setq end (copy-marker end t)))
852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878
    (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))))
879
		  (goto-char pt1)
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
		  (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)) " @@")))))))))))
915 916 917 918

(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
919
else cover the whole buffer."
920 921
  (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
		   (list (region-beginning) (region-end))
922
		 (list (point-min) (point-max))))
923
  (unless (markerp end) (setq end (copy-marker end t)))
924 925 926 927
  (let (;;(diff-inhibit-after-change t)
	(inhibit-read-only t))
    (save-excursion
      (goto-char start)
928
      (while (and (re-search-forward "^\\(\\([-*][-*][-*] \\)\\(.+\\)\n\\([-+][-+][-+] \\)\\(.+\\)\\|\\*\\{15\\}.*\n\\*\\*\\* \\(.+\\) \\*\\*\\*\\*\\|@@ -\\([0-9,]+\\) \\+\\([0-9,]+\\) @@.*\\)$" nil t)
929 930 931 932 933 934 935 936 937 938 939 940
		  (< (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)))
941
		(while (looking-at "[-! \\][ \t]\\|#")
942 943
		  (when (= (char-after) ?-) (delete-char 1) (insert "+"))
		  (forward-line 1))
944
		(let ((half1 (delete-and-extract-region half1s (point))))
945 946 947 948 949 950 951
		  (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)))
952
		      (while (looking-at "[!+ \\][ \t]\\|#")
953 954
			(when (= (char-after) ?+) (delete-char 1) (insert "-"))
			(forward-line 1))
955
		      (let ((half2 (delete-and-extract-region half2s (point))))
956
			(insert (or half1 ""))
957
			(goto-char half1s)
958
			(insert (or half2 ""))))
959 960 961 962 963 964 965 966 967 968 969 970
		    (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)
971
		       ((?\\ ?#) t)
972
		       (t (when (and first last (< first last))
973
			    (insert (delete-and-extract-region first last)))
974
			  (setq first nil last nil)
975 976
			  (memq c (if diff-valid-unified-empty-line
                                      '(?\s ?\n) '(?\s)))))
977 978 979 980 981
		(forward-line 1