diff-mode.el 61.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
;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4
;;   2005, 2006, 2007 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
;; - 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
  "Non-nil means `diff-goto-source' jumps to the old file.
76
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 115 116
    ("n" . diff-hunk-next)
    ("N" . diff-file-next)
    ("p" . diff-hunk-prev)
    ("P" . diff-file-prev)
    ("k" . diff-hunk-kill)
    ("K" . diff-file-kill)
117
    ;; From compilation-minor-mode.
118 119
    ("}" . diff-file-next)
    ("{" . diff-file-prev)
120
    ("\C-m" . diff-goto-source)
121
    ([mouse-2] . diff-goto-source)
122
    ;; From XEmacs' diff-mode.
123 124
    ;; Standard M-w is useful, so don't change M-W.
    ;;("W" . widen)
125 126 127 128 129 130 131 132
    ;;("." . 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)
133 134 135 136 137 138 139 140
    ;; 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
141
    ("q" . quit-window))
142
  "Basic keymap for `diff-mode', bound to various prefix keys.")
143

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

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

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

195

196
;;;;
197
;;;; font-lock support
198
;;;;
199

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

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

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

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

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

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

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

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

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

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

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

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

342

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

(defconst diff-font-lock-defaults
369
  '(diff-font-lock-keywords t nil nil nil (font-lock-multiline . nil)))
370

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

378
;;;;
379
;;;; Movement
380
;;;;
381

382
(defconst diff-hunk-header-re "^\\(@@ -[0-9,]+ \\+[0-9,]+ @@.*\\|\\*\\{15\\}.*\n\\*\\*\\* .+ \\*\\*\\*\\*\\|[0-9]+\\(,[0-9]+\\)?[acd][0-9]+\\(,[0-9]+\\)?\\)$")
383
(defconst diff-file-header-re (concat "^\\(--- .+\n\\+\\+\\+ \\|\\*\\*\\* .+\n--- \\|[^-+!<>0-9@* ]\\).+\n" (substring diff-hunk-header-re 1)))
384 385 386
(defvar diff-narrowed-to nil)

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

404 405 406 407
(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."
408 409 410 411 412
  (beginning-of-line)
  (unless (looking-at diff-hunk-header-re)
    (forward-line 1)
    (condition-case ()
	(re-search-backward diff-hunk-header-re)
413 414 415 416 417
      (error
       (if (not try-harder)
           (error "Can't find the beginning of the hunk")
         (diff-beginning-of-file-and-junk)
         (diff-hunk-next))))))
418 419 420 421 422 423 424 425 426 427

(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 ()
428
  (re-search-forward "^[-+#!<>0-9@* \\]" nil t)
429 430 431 432 433
  (re-search-forward (concat "^[^-+#!<>0-9@* \\]\\|" diff-file-header-re)
		     nil 'move)
  (if (match-beginning 1)
      (goto-char (match-beginning 1))
    (beginning-of-line)))
434

435 436
;; Define diff-{hunk,file}-{prev,next}
(easy-mmode-define-navigation
437
 diff-hunk diff-hunk-header-re "hunk" diff-end-of-hunk diff-restrict-view)
438 439
(easy-mmode-define-navigation
 diff-file diff-file-header-re "file" diff-end-of-hunk)
440 441 442 443 444 445

(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
446
    (if arg (diff-beginning-of-file) (diff-beginning-of-hunk 'try-harder))
447 448 449 450 451 452
    (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))))


453
(defun diff-hunk-kill ()
454 455 456
  "Kill current hunk."
  (interactive)
  (diff-beginning-of-hunk)
457
  (let* ((start (point))
458 459
	 (nexthunk (when (re-search-forward diff-hunk-header-re nil t)
		     (match-beginning 0)))
460 461 462
	 (firsthunk (ignore-errors
		      (goto-char start)
		      (diff-beginning-of-file) (diff-hunk-next) (point)))
463 464
	 (nextfile (ignore-errors (diff-file-next) (point)))
	 (inhibit-read-only t))
465
    (goto-char start)
466 467 468
    (if (and firsthunk (= firsthunk start)
	     (or (null nexthunk)
		 (and nextfile (> nexthunk nextfile))))
469
	;; It's the only hunk for this file, so kill the file.
470
	(diff-file-kill)
471 472 473
      (diff-end-of-hunk)
      (kill-region start (point)))))

474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
(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."
  (let ((start (point))
        (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
                   (re-search-backward "^Index: " prevhunk t))))
      (when index (setq file index))
      (if (<= file start)
          (goto-char file)
        ;; File starts *after* the starting point: we really weren't in
        ;; a file diff but elsewhere.
        (goto-char start)
        (signal (car err) (cdr err))))))
          
499
(defun diff-file-kill ()
500 501
  "Kill current file's hunks."
  (interactive)
502
  (diff-beginning-of-file-and-junk)
503
  (let* ((start (point))
504
	 (inhibit-read-only t))
505
    (diff-end-of-file)
506
    (if (looking-at "^\n") (forward-char 1)) ;`tla' generates such diffs.
507 508
    (kill-region start (point))))

509 510 511 512 513 514 515 516 517 518 519 520 521 522 523
(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)))))

524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
(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)))
543 544
	   (newstart2 (+ start2 (diff-count-matches "^[+ \t]" (point) pos)))
	   (inhibit-read-only t))
545 546 547 548 549 550
      (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))))
551

552

553 554 555 556
;;;;
;;;; jump to other buffers
;;;;

557 558
(defvar diff-remembered-files-alist nil)

559 560 561
(defun diff-filename-drop-dir (file)
  (when (string-match "/" file) (substring file (match-end 0))))

562 563 564
(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.
565
The strings are assumed not to contain any \"\\n\" (i.e. end of line).
566 567 568 569 570 571 572 573
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
574
  (let ((str (concat ancestor "\n" from "\n" to)))
575
    (when (and (string-match (concat
576 577
			      "\\`\\(.*?\\)\\(.*\\)\\(.*\\)\n"
			      "\\1\\(.*\\)\\3\n"
578 579 580 581 582 583
			      "\\(.*\\(\\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))))))

584 585 586 587 588 589 590 591 592 593 594 595
(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)))
596

597 598
(defun diff-hunk-file-names (&optional old)
  "Give the list of file names textually mentioned for the current hunk."
599 600 601 602
  (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)))
603
    (let ((limit (save-excursion
604
		   (condition-case ()
605
		       (progn (diff-hunk-prev) (point))
606
		     (error (point-min)))))
607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
	  (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)))))))))

625
(defun diff-find-file-name (&optional old batch prefix)
626
  "Return the file corresponding to the current patch.
627
Non-nil OLD means that we want the old file.
628 629
Non-nil BATCH means to prefer returning an incorrect answer than to prompt
the user.
630
PREFIX is only used internally: don't use it."
631 632 633 634 635
  (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)))
636
      (if prefix (setq fs (mapcar (lambda (f) (concat prefix f)) fs)))
637
      (or
638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
       ;; 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>
655 656 657
       (and (string-match "\\.rej\\'" (or buffer-file-name ""))
	    (let ((file (substring buffer-file-name 0 (match-beginning 0))))
	      (when (file-exists-p file) file)))
658 659 660 661 662 663
       ;; 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))
664 665 666 667
	    (diff-find-file-name old batch (match-string 1)))
       ;; Invent something, if necessary.
       (when batch
         (or (car fs) default-directory))
668 669 670 671 672
       ;; 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))
673 674
	 file)))))

675

676 677 678 679
(defun diff-ediff-patch ()
  "Call `ediff-patch-file' on the current buffer."
  (interactive)
  (condition-case err
680
      (ediff-patch-file nil (current-buffer))
681 682
    (wrong-number-of-arguments (ediff-patch-file))))

683
;;;;
684
;;;; Conversion functions
685
;;;;
686 687 688 689 690 691 692 693

;;(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."
694 695
  (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
		   (list (region-beginning) (region-end))
696
		 (list (point-min) (point-max))))
697
  (unless (markerp end) (setq end (copy-marker end t)))
698 699 700 701
  (let (;;(diff-inhibit-after-change t)
	(inhibit-read-only t))
    (save-excursion
      (goto-char start)
702
      (while (and (re-search-forward "^\\(\\(---\\) .+\n\\(\\+\\+\\+\\) .+\\|@@ -\\([0-9]+\\),\\([0-9]+\\) \\+\\([0-9]+\\),\\([0-9]+\\) @@.*\\)$" nil t)
703 704 705
		  (< (point) end))
	(combine-after-change-calls
	  (if (match-beginning 2)
706
	      ;; we matched a file header
707 708 709 710 711 712 713 714
	      (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))
715 716 717 718 719 720
		  (lines2 (match-string 7))
		  ;; Variables to use the special undo function.
		  (old-undo buffer-undo-list)
		  (old-end (marker-position end))
		  (start (match-beginning 0))
		  (reversible t))
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
	      (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
739
			  (?\s (insert " ") (setq modif nil) (backward-char 1))
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
			  (?+ (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))
762 763 764 765 766 767 768 769
		      (if (save-excursion (re-search-forward "^\\+.*\n-" nil t))
                          ;; Normally, lines in a substitution come with
                          ;; first the removals and then the additions, and
                          ;; the context->unified function follows this
                          ;; convention, of course.  Yet, other alternatives
                          ;; are valid as well, but they preclude the use of
                          ;; context->unified as an undo command.
			  (setq reversible nil))
770 771
		      (while (not (eobp))
			(case (char-after)
Juanma Barranquero's avatar
Juanma Barranquero committed
772
			  (?\s (insert " ") (setq modif nil) (backward-char 1))
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787
			  (?- (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))
788 789 790 791 792 793 794 795 796
			    (setq delete nil)))))))
		(unless (or (not reversible) (eq buffer-undo-list t))
                  ;; Drop the many undo entries and replace them with
                  ;; a single entry that uses diff-context->unified to do
                  ;; the work.
		  (setq buffer-undo-list
			(cons (list 'apply (- old-end end) start (point-max)
				    'diff-context->unified start (point-max))
			      old-undo)))))))))))
797

798
(defun diff-context->unified (start end &optional to-context)
799
  "Convert context diffs to unified diffs.
800 801 802 803
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)
804
		   (list (region-beginning) (region-end) current-prefix-arg)
805 806 807
		 (list (point-min) (point-max) current-prefix-arg)))
  (if to-context
      (diff-unified->context start end)
808
    (unless (markerp end) (setq end (copy-marker end t)))
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
    (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))))
836
		  (goto-char pt1)
837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
		  (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)) " @@")))))))))))
872 873 874 875 876

(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."
877 878
  (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
		   (list (region-beginning) (region-end))
879
		 (list (point-min) (point-max))))
880
  (unless (markerp end) (setq end (copy-marker end t)))
881 882 883 884
  (let (;;(diff-inhibit-after-change t)
	(inhibit-read-only t))
    (save-excursion
      (goto-char start)
885
      (while (and (re-search-forward "^\\(\\([-*][-*][-*] \\)\\(.+\\)\n\\([-+][-+][-+] \\)\\(.+\\)\\|\\*\\{15\\}.*\n\\*\\*\\* \\(.+\\) \\*\\*\\*\\*\\|@@ -\\([0-9,]+\\) \\+\\([0-9,]+\\) @@.*\\)$" nil t)
886 887 888 889 890 891 892 893 894 895 896 897
		  (< (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)))
898
		(while (looking-at "[-! \\][ \t]\\|#")
899 900
		  (when (= (char-after) ?-) (delete-char 1) (insert "+"))
		  (forward-line 1))
901
		(let ((half1 (delete-and-extract-region half1s (point))))
902 903 904 905 906 907 908
		  (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)))
909
		      (while (looking-at "[!+ \\][ \t]\\|#")
910 911
			(when (= (char-after) ?+) (delete-char 1) (insert "-"))
			(forward-line 1))
912
		      (let ((half2 (delete-and-extract-region half2s (point))))
913
			(insert (or half1 ""))
914
			(goto-char half1s)
915
			(insert (or half2 ""))))
916 917 918 919 920 921 922 923 924 925 926 927
		    (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)
928
		       ((?\\ ?#) t)
929
		       (t (when (and first last (< first last))
930
			    (insert (delete-and-extract-region first last)))
931
			  (setq first nil last nil)
932
			  (equal ?\s c)))
933 934 935 936 937 938
		(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."
939 940
  (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
		   (list (region-beginning) (region-end))
941 942 943 944 945 946
		 (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)))
947 948 949 950
	  (if (not (looking-at
		    (concat "@@ -[0-9,]+ \\+[0-9,]+ @@"
			    "\\|[-*][-*][-*] [0-9,]+ [-*][-*][-*][-*]$"
			    "\\|--- .+\n\\+\\+\\+ ")))
951
	      (case (char-after)
952
		(?\s (incf space))
953 954 955
		(?+ (incf plus))
		(?- (incf minus))
		(?! (incf bang))
956
		((?\\ ?#) nil)
957 958
		(t  (setq space 0 plus 0 minus 0 bang 0)))
	    (cond
959
	     ((looking-at "@@ -[0-9]+,\\([0-9]*\\) \\+[0-9]+,\\([0-9]*\\) @@.*$")
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
	      (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)))))))

982
;;;;
983
;;;; Hooks
984
;;;;
985 986 987 988 989 990 991 992 993 994 995 996 997

(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."
Stefan Monnier's avatar