diff-mode.el 75.3 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, 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
;; - Improve `diff-add-change-log-entries-other-window',
;;   it is very simplistic now.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
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".
52
;;   Maybe just use `wiggle' (by Neil Brown) to do it for us.
53
;;
54 55
;; - in diff-apply-hunk, strip context in replace-match to better
;;   preserve markers and spacing.
56
;; - Handle `diff -b' output in context->unified.
57 58 59 60

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

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

63 64

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

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

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

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

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

Stefan Monnier's avatar
Stefan Monnier committed
96 97
(defcustom diff-auto-refine t
  "Automatically highlight changes in detail as the user visits hunks."
98 99
  :type 'boolean
  :group 'diff-mode)
100

101 102 103
(defcustom diff-mode-hook nil
  "Run after setting up the `diff-mode' major mode."
  :type 'hook
104 105
  :options '(diff-delete-empty-files diff-make-unified)
  :group 'diff-mode)
106 107 108 109

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

110
;;;;
111
;;;; keymap, menu, ...
112
;;;;
113

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

151
(easy-mmode-defmap diff-mode-map
152
  `(("\e" . ,diff-mode-shared-map)
153 154
    ;; From compilation-minor-mode.
    ("\C-c\C-c" . diff-goto-source)
155 156
    ;; By analogy with the global C-x 4 a binding.
    ("\C-x4A" . diff-add-change-log-entries-other-window)
157
    ;; Misc operations.
158
    ("\C-c\C-a" . diff-apply-hunk)
159 160 161
    ("\C-c\C-e" . diff-ediff-patch)
    ("\C-c\C-n" . diff-restrict-view)
    ("\C-c\C-s" . diff-split-hunk)
162
    ("\C-c\C-t" . diff-test-hunk)
Stefan Monnier's avatar
Stefan Monnier committed
163
    ("\C-c\C-r" . diff-reverse-direction)
164
    ("\C-c\C-u" . diff-context->unified)
165 166
    ;; `d' because it duplicates the context :-(  --Stef
    ("\C-c\C-d" . diff-unified->context)
Stefan Monnier's avatar
Stefan Monnier committed
167 168
    ("\C-c\C-w" . diff-ignore-whitespace-hunk)
    ("\C-c\C-b" . diff-refine-hunk)  ;No reason for `b' :-(
169
    ("\C-c\C-f" . next-error-follow-minor-mode))
170 171 172 173 174
  "Keymap for `diff-mode'.  See also `diff-mode-shared-map'.")

(easy-menu-define diff-mode-menu diff-mode-map
  "Menu for `diff-mode'."
  '("Diff"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
175 176 177 178 179 180 181 182
    ["Jump to Source"		diff-goto-source
     :help "Jump to the corresponding source line"]
    ["Apply hunk"		diff-apply-hunk
     :help "Apply the current hunk to the source file and go to the next"]
    ["Test applying hunk"	diff-test-hunk
     :help "See whether it's possible to apply the current hunk"]
    ["Apply diff with Ediff"	diff-ediff-patch
     :help "Call `ediff-patch-file' on the current buffer"]
183
    ["Create Change Log entries" diff-add-change-log-entries-other-window
Dan Nicolaescu's avatar
Dan Nicolaescu committed
184
     :help "Create ChangeLog entries for the changes in the diff buffer"]
Stefan Monnier's avatar
Stefan Monnier committed
185
    "-----"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
186 187 188 189 190 191
    ["Reverse direction"	diff-reverse-direction
     :help "Reverse the direction of the diffs"]
    ["Context -> Unified"	diff-context->unified
     :help "Convert context diffs to unified diffs"]
    ["Unified -> Context"	diff-unified->context
     :help "Convert unified diffs to context diffs"]
192
    ;;["Fixup Headers"		diff-fixup-modifs	(not buffer-read-only)]
Stefan Monnier's avatar
Stefan Monnier committed
193
    "-----"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
194 195 196 197 198 199 200 201 202 203 204
    ["Split hunk"		diff-split-hunk
     :active (diff-splittable-p)
     :help "Split the current (unified diff) hunk at point into two hunks"]
    ["Ignore whitespace changes" diff-ignore-whitespace-hunk
     :help "Re-diff the current hunk, ignoring whitespace differences"]
    ["Highlight fine changes"	diff-refine-hunk
     :help "Highlight changes of hunk at point at a finer granularity"]
    ["Kill current hunk"	diff-hunk-kill
     :help "Kill current hunk"]
    ["Kill current file's hunks" diff-file-kill
     :help "Kill all current file's hunks"]
Stefan Monnier's avatar
Stefan Monnier committed
205
    "-----"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
206 207 208 209 210 211 212 213
    ["Previous Hunk"		diff-hunk-prev
     :help "Go to the previous count'th hunk"]
    ["Next Hunk"		diff-hunk-next
     :help "Go to the next count'th hunk"]
    ["Previous File"		diff-file-prev
     :help "Go to the previous count'th file"]
    ["Next File"		diff-file-next
     :help "Go to the next count'th file"]
214 215
    ))

216
(defcustom diff-minor-mode-prefix "\C-c="
217
  "Prefix key for `diff-minor-mode' commands."
218 219
  :type '(choice (string "\e") (string "C-c=") string)
  :group 'diff-mode)
220

221 222
(easy-mmode-defmap diff-minor-mode-map
  `((,diff-minor-mode-prefix . ,diff-mode-shared-map))
223 224
  "Keymap for `diff-minor-mode'.  See also `diff-mode-shared-map'.")

225

226
;;;;
227
;;;; font-lock support
228
;;;;
229

230
(defface diff-header
231
  '((((class color) (min-colors 88) (background light))
232
     :background "grey85")
233
    (((class color) (min-colors 88) (background dark))
234
     :background "grey45")
235
    (((class color) (background light))
236
     :foreground "blue1" :weight bold)
237
    (((class color) (background dark))
238 239
     :foreground "green" :weight bold)
    (t :weight bold))
240 241
  "`diff-mode' face inherited by hunk and index header faces."
  :group 'diff-mode)
242 243 244
;; backward-compatibility alias
(put 'diff-header-face 'face-alias 'diff-header)
(defvar diff-header-face 'diff-header)
Stefan Monnier's avatar
Stefan Monnier committed
245

246
(defface diff-file-header
247
  '((((class color) (min-colors 88) (background light))
248
     :background "grey70" :weight bold)
249
    (((class color) (min-colors 88) (background dark))
250
     :background "grey60" :weight bold)
251
    (((class color) (background light))
252
     :foreground "green" :weight bold)
253
    (((class color) (background dark))
254 255
     :foreground "cyan" :weight bold)
    (t :weight bold))			; :height 1.3
256 257
  "`diff-mode' face used to highlight file header lines."
  :group 'diff-mode)
258 259 260
;; backward-compatibility alias
(put 'diff-file-header-face 'face-alias 'diff-file-header)
(defvar diff-file-header-face 'diff-file-header)
261

262 263
(defface diff-index
  '((t :inherit diff-file-header))
264 265
  "`diff-mode' face used to highlight index header lines."
  :group 'diff-mode)
266 267 268
;; backward-compatibility alias
(put 'diff-index-face 'face-alias 'diff-index)
(defvar diff-index-face 'diff-index)
269

270 271
(defface diff-hunk-header
  '((t :inherit diff-header))
272 273
  "`diff-mode' face used to highlight hunk header lines."
  :group 'diff-mode)
274 275 276
;; backward-compatibility alias
(put 'diff-hunk-header-face 'face-alias 'diff-hunk-header)
(defvar diff-hunk-header-face 'diff-hunk-header)
277

278 279
(defface diff-removed
  '((t :inherit diff-changed))
280 281
  "`diff-mode' face used to highlight removed lines."
  :group 'diff-mode)
282 283 284
;; backward-compatibility alias
(put 'diff-removed-face 'face-alias 'diff-removed)
(defvar diff-removed-face 'diff-removed)
285

286 287
(defface diff-added
  '((t :inherit diff-changed))
288 289
  "`diff-mode' face used to highlight added lines."
  :group 'diff-mode)
290 291 292
;; backward-compatibility alias
(put 'diff-added-face 'face-alias 'diff-added)
(defvar diff-added-face 'diff-added)
293

294
(defface diff-changed
295
  '((((type tty pc) (class color) (background light))
296
     :foreground "magenta" :weight bold :slant italic)
297
    (((type tty pc) (class color) (background dark))
298
     :foreground "yellow" :weight bold :slant italic))
299 300
  "`diff-mode' face used to highlight changed lines."
  :group 'diff-mode)
301 302 303
;; backward-compatibility alias
(put 'diff-changed-face 'face-alias 'diff-changed)
(defvar diff-changed-face 'diff-changed)
304

305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
(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)

326
(defface diff-function
327
  '((t :inherit diff-header))
328 329
  "`diff-mode' face used to highlight function names produced by \"diff -p\"."
  :group 'diff-mode)
330 331 332
;; backward-compatibility alias
(put 'diff-function-face 'face-alias 'diff-function)
(defvar diff-function-face 'diff-function)
333

334
(defface diff-context
335
  '((((class color grayscale) (min-colors 88)) :inherit shadow))
336 337
  "`diff-mode' face used to highlight context and other side-information."
  :group 'diff-mode)
338 339 340
;; backward-compatibility alias
(put 'diff-context-face 'face-alias 'diff-context)
(defvar diff-context-face 'diff-context)
Stefan Monnier's avatar
Stefan Monnier committed
341

342 343
(defface diff-nonexistent
  '((t :inherit diff-file-header))
344 345
  "`diff-mode' face used to highlight nonexistent files in recursive diffs."
  :group 'diff-mode)
346 347 348
;; backward-compatibility alias
(put 'diff-nonexistent-face 'face-alias 'diff-nonexistent)
(defvar diff-nonexistent-face 'diff-nonexistent)
349

350 351
(defconst diff-yank-handler '(diff-yank-function))
(defun diff-yank-function (text)
352 353 354
  ;; 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
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
  (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)))))))
371

372 373
(defconst diff-hunk-header-re-unified
  "^@@ -\\([0-9]+\\)\\(?:,\\([0-9]+\\)\\)? \\+\\([0-9]+\\)\\(?:,\\([0-9]+\\)\\) @@")
374

375
(defvar diff-font-lock-keywords
376 377
  `((,(concat "\\(" diff-hunk-header-re-unified "\\)\\(.*\\)$")
     (1 diff-hunk-header-face) (6 diff-function-face))
378 379
    ("^\\(\\*\\{15\\}\\)\\(.*\\)$"                        ;context
     (1 diff-hunk-header-face) (2 diff-function-face))
380
    ("^\\*\\*\\* .+ \\*\\*\\*\\*". diff-hunk-header-face) ;context
381 382 383
    ("^--- .+ ----$"             . diff-hunk-header-face) ;context
    ("^[0-9,]+[acd][0-9,]+$"     . diff-hunk-header-face) ;normal
    ("^---$"                     . diff-hunk-header-face) ;normal
384 385 386 387 388
    ;; For file headers, accept files with spaces, but be careful to rule
    ;; out false-positives when matching hunk headers.
    ("^\\(---\\|\\+\\+\\+\\|\\*\\*\\*\\) \\([^\t\n]+?\\)\\(?:\t.*\\| \\(\\*\\*\\*\\*\\|----\\)\\)?\n"
     (0 diff-header-face)
     (2 (if (not (match-end 3)) diff-file-header-face) prepend))
389 390 391 392 393 394 395 396
    ("^\\([-<]\\)\\(.*\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))
397
    ("^Only in .*\n" . diff-nonexistent-face)
398
    ("^\\(#\\)\\(.*\\)"
399 400
     (1 font-lock-comment-delimiter-face)
     (2 font-lock-comment-face))
401
    ("^[^-=+*!<>#].*\n" (0 diff-context-face))))
402 403

(defconst diff-font-lock-defaults
404
  '(diff-font-lock-keywords t nil nil nil (font-lock-multiline . nil)))
405

406 407
(defvar diff-imenu-generic-expression
  ;; Prefer second name as first is most likely to be a backup or
408 409 410
  ;; 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
411 412
    (nil "^--- \\([^\t\n]+\\)\t.*\n\\*" 1))) ; context diffs

413
;;;;
414
;;;; Movement
415
;;;;
416

417 418 419 420 421 422 423 424
(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]+\\)?\\)$"))
425
(defconst diff-file-header-re (concat "^\\(--- .+\n\\+\\+\\+ \\|\\*\\*\\* .+\n--- \\|[^-+!<>0-9@* ]\\).+\n" (substring diff-hunk-header-re 1)))
426 427
(defvar diff-narrowed-to nil)

Stefan Monnier's avatar
Stefan Monnier committed
428
(defun diff-hunk-style (&optional style)
429
  (when (looking-at diff-hunk-header-re)
Stefan Monnier's avatar
Stefan Monnier committed
430
    (setq style (cdr (assq (char-after) '((?@ . unified) (?* . context)))))
431
    (goto-char (match-end 0)))
Stefan Monnier's avatar
Stefan Monnier committed
432 433
  style)

434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
(defun diff-end-of-hunk (&optional style donttrustheader)
  (let (end)
    (when (looking-at diff-hunk-header-re)
      ;; Especially important for unified (because headers are ambiguous).
      (setq style (diff-hunk-style style))
      (goto-char (match-end 0))
      (when (and (not donttrustheader) (match-end 2))
        (save-excursion
          (re-search-forward (if diff-valid-unified-empty-line
                                 "^[- \n]" "^[- ]")
                             nil t
                             (string-to-number (match-string 2)))
          (setq end (line-beginning-position 2)))))
    ;; 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)))))
467 468
    ;; The return value is used by easy-mmode-define-navigation.
    (goto-char (or end (point-max)))))
469

470 471 472 473
(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."
474 475 476 477 478
  (beginning-of-line)
  (unless (looking-at diff-hunk-header-re)
    (forward-line 1)
    (condition-case ()
	(re-search-backward diff-hunk-header-re)
479 480 481 482 483
      (error
       (if (not try-harder)
           (error "Can't find the beginning of the hunk")
         (diff-beginning-of-file-and-junk)
         (diff-hunk-next))))))
484

485 486 487 488 489 490
(defun diff-unified-hunk-p ()
  (save-excursion
    (ignore-errors
      (diff-beginning-of-hunk)
      (looking-at "^@@"))))

491 492 493
(defun diff-beginning-of-file ()
  (beginning-of-line)
  (unless (looking-at diff-file-header-re)
494 495 496 497 498 499 500 501 502 503 504 505 506 507
    (let ((start (point))
          res)
      ;; diff-file-header-re may need to match up to 4 lines, so in case
      ;; we're inside the header, we need to move up to 3 lines forward.
      (forward-line 3)
      (if (and (setq res (re-search-backward diff-file-header-re nil t))
               ;; Maybe the 3 lines forward were too much and we matched
               ;; a file header after our starting point :-(
               (or (<= (point) start)
                   (setq res (re-search-backward diff-file-header-re nil t))))
          res
        (goto-char start)
        (error "Can't find the beginning of the file")))))
        
508 509

(defun diff-end-of-file ()
510
  (re-search-forward "^[-+#!<>0-9@* \\]" nil t)
511 512 513 514 515
  (re-search-forward (concat "^[^-+#!<>0-9@* \\]\\|" diff-file-header-re)
		     nil 'move)
  (if (match-beginning 1)
      (goto-char (match-beginning 1))
    (beginning-of-line)))
516

517 518
;; Define diff-{hunk,file}-{prev,next}
(easy-mmode-define-navigation
Stefan Monnier's avatar
Stefan Monnier committed
519 520 521 522
 diff-hunk diff-hunk-header-re "hunk" diff-end-of-hunk diff-restrict-view
 (if diff-auto-refine
     (condition-case-no-debug nil (diff-refine-hunk) (error nil))))

523 524
(easy-mmode-define-navigation
 diff-file diff-file-header-re "file" diff-end-of-hunk)
525 526 527 528 529 530

(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
531
    (if arg (diff-beginning-of-file) (diff-beginning-of-hunk 'try-harder))
532 533 534 535 536 537
    (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))))


538
(defun diff-hunk-kill ()
539 540 541
  "Kill current hunk."
  (interactive)
  (diff-beginning-of-hunk)
542
  (let* ((start (point))
543 544
	 (nexthunk (when (re-search-forward diff-hunk-header-re nil t)
		     (match-beginning 0)))
545 546 547
	 (firsthunk (ignore-errors
		      (goto-char start)
		      (diff-beginning-of-file) (diff-hunk-next) (point)))
548 549
	 (nextfile (ignore-errors (diff-file-next) (point)))
	 (inhibit-read-only t))
550
    (goto-char start)
551 552 553
    (if (and firsthunk (= firsthunk start)
	     (or (null nexthunk)
		 (and nextfile (> nexthunk nextfile))))
554
	;; It's the only hunk for this file, so kill the file.
555
	(diff-file-kill)
556 557 558
      (diff-end-of-hunk)
      (kill-region start (point)))))

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

561 562 563 564
(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."
565 566 567 568 569 570 571
  (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))
572 573 574 575 576 577 578 579 580 581 582 583 584
         (prevfile (condition-case err
                       (save-excursion (diff-beginning-of-file) (point))
                     (error err)))
         (err (if (consp prevfile) prevfile))
         (nextfile (ignore-errors
                     (save-excursion
                       (goto-char start) (diff-file-next) (point))))
         ;; prevhunk is one of the limits.
         (prevhunk (save-excursion
                     (ignore-errors
                       (if (numberp prevfile) (goto-char prevfile))
                       (diff-hunk-prev) (point))))
         (previndex (save-excursion
585
                      (forward-line 1)  ;In case we're looking at "Index:".
586 587 588 589 590 591 592 593 594
                      (re-search-backward "^Index: " prevhunk t))))
    ;; If we're in the junk, we should use nextfile instead of prevfile.
    (if (and (numberp nextfile)
             (or (not (numberp prevfile))
                 (and previndex (> previndex prevfile))))
        (setq prevfile nextfile))
    (if (and previndex (numberp prevfile) (< previndex prevfile))
        (setq prevfile previndex))
    (if (and (numberp prevfile) (<= prevfile start))
595 596 597 598 599 600 601 602
          (progn
            (goto-char prevfile)
            ;; 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)))
603 604
      ;; File starts *after* the starting point: we really weren't in
      ;; a file diff but elsewhere.
605
      (goto-char orig)
606
      (signal (car err) (cdr err)))))
607
          
608
(defun diff-file-kill ()
609 610
  "Kill current file's hunks."
  (interactive)
611 612
  (let ((orig (point))
        (start (progn (diff-beginning-of-file-and-junk) (point)))
613
	 (inhibit-read-only t))
614
    (diff-end-of-file)
615
    (if (looking-at "^\n") (forward-char 1)) ;`tla' generates such diffs.
616
    (if (> orig (point)) (error "Not inside a file diff"))
617 618
    (kill-region start (point))))

619 620 621 622 623 624 625 626 627 628 629 630 631 632 633
(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)))))

634 635 636 637 638 639 640
(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)))

641 642 643 644 645 646 647
(defun diff-splittable-p ()
  (save-excursion
    (beginning-of-line)
    (and (looking-at "^[-+ ]")
         (progn (forward-line -1) (looking-at "^[-+ ]"))
         (diff-unified-hunk-p))))

648 649 650 651 652 653
(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))))
654
    (unless (looking-at diff-hunk-header-re-unified)
655 656 657
      (error "diff-split-hunk only works on unified context diffs"))
    (forward-line 1)
    (let* ((start1 (string-to-number (match-string 1)))
658
	   (start2 (string-to-number (match-string 3)))
659
	   (newstart1 (+ start1 (diff-count-matches "^[- \t]" (point) pos)))
660 661
	   (newstart2 (+ start2 (diff-count-matches "^[+ \t]" (point) pos)))
	   (inhibit-read-only t))
662 663 664 665 666 667
      (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))))
668

669

670 671 672 673
;;;;
;;;; jump to other buffers
;;;;

674 675
(defvar diff-remembered-files-alist nil)

676 677 678
(defun diff-filename-drop-dir (file)
  (when (string-match "/" file) (substring file (match-end 0))))

679 680 681
(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.
682
The strings are assumed not to contain any \"\\n\" (i.e. end of line).
683 684 685 686 687 688 689 690
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
691
  (let ((str (concat ancestor "\n" from "\n" to)))
692
    (when (and (string-match (concat
693 694
			      "\\`\\(.*?\\)\\(.*\\)\\(.*\\)\n"
			      "\\1\\(.*\\)\\3\n"
695 696 697 698 699 700
			      "\\(.*\\(\\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))))))

701 702 703 704 705 706 707 708 709 710 711 712
(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)))
713

714 715
(defun diff-hunk-file-names (&optional old)
  "Give the list of file names textually mentioned for the current hunk."
716 717 718 719
  (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)))
720
    (let ((limit (save-excursion
721
		   (condition-case ()
722
		       (progn (diff-hunk-prev) (point))
723
		     (error (point-min)))))
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741
	  (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)))))))))

742
(defun diff-find-file-name (&optional old batch prefix)
743
  "Return the file corresponding to the current patch.
744
Non-nil OLD means that we want the old file.
745 746
Non-nil BATCH means to prefer returning an incorrect answer than to prompt
the user.
747
PREFIX is only used internally: don't use it."
748 749 750 751 752
  (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)))
753
      (if prefix (setq fs (mapcar (lambda (f) (concat prefix f)) fs)))
754
      (or
755 756 757 758 759 760 761 762 763 764 765 766 767
       ;; 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)))
768 769 770
			       ;; Use file-regular-p to avoid
			       ;; /dev/null, directories, etc.
			       ((or (null file) (file-regular-p file))
771 772 773
				file))))
	    file))
       ;; <foo>.rej patches implicitly apply to <foo>
774 775 776
       (and (string-match "\\.rej\\'" (or buffer-file-name ""))
	    (let ((file (substring buffer-file-name 0 (match-beginning 0))))
	      (when (file-exists-p file) file)))
777 778 779 780 781 782
       ;; 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))
783 784 785 786
	    (diff-find-file-name old batch (match-string 1)))
       ;; Invent something, if necessary.
       (when batch
         (or (car fs) default-directory))
787 788 789 790 791
       ;; 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))
792 793
	 file)))))

794

795 796 797 798
(defun diff-ediff-patch ()
  "Call `ediff-patch-file' on the current buffer."
  (interactive)
  (condition-case err
799
      (ediff-patch-file nil (current-buffer))
800 801
    (wrong-number-of-arguments (ediff-patch-file))))

802
;;;;
803
;;;; Conversion functions
804
;;;;
805 806 807 808 809 810 811

;;(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
812
else cover the whole buffer."
813 814
  (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
		   (list (region-beginning) (region-end))
815
		 (list (point-min) (point-max))))
816
  (unless (markerp end) (setq end (copy-marker end t)))
817 818 819 820
  (let (;;(diff-inhibit-after-change t)
	(inhibit-read-only t))
    (save-excursion
      (goto-char start)
821 822 823 824
      (while (and (re-search-forward
                   (concat "^\\(\\(---\\) .+\n\\(\\+\\+\\+\\) .+\\|"
                           diff-hunk-header-re-unified ".*\\)$")
                   nil t)
825 826 827
		  (< (point) end))
	(combine-after-change-calls
	  (if (match-beginning 2)
828
	      ;; we matched a file header
829 830 831 832 833 834
	      (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))
835 836
		  (lines1 (if (match-end 5)
                              (string-to-number (match-string 5)) 1))
837
		  (line2 (match-string 6))
838 839
		  (lines2 (if (match-end 7)
                              (string-to-number (match-string 7)) 1))
840 841 842 843 844
		  ;; Variables to use the special undo function.
		  (old-undo buffer-undo-list)
		  (old-end (marker-position end))
		  (start (match-beginning 0))
		  (reversible t))
845 846 847
	      (replace-match
	       (concat "***************\n*** " line1 ","
		       (number-to-string (+ (string-to-number line1)
848
					    lines1 -1)) " ****"))
849
	      (save-restriction
850 851 852 853
		(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.
854 855 856 857 858 859 860 861 862 863
				  (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
864
			  (?\s (insert " ") (setq modif nil) (backward-char 1))
865 866 867 868 869 870 871 872 873 874
			  (?+ (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)))
875 876
                          ;; diff-valid-unified-empty-line.
                          (?\n (insert "  ") (setq modif nil) (backward-char 2))
877 878 879 880 881
			  (t (setq modif nil))))))
		  (goto-char (point-max))
		  (save-excursion
		    (insert "--- " line2 ","
			    (number-to-string (+ (string-to-number line2)
882 883
						 lines2 -1))
                            " ----\n" hunk))
884 885 886 887 888
		  ;;(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))
889 890 891 892 893 894 895 896
		      (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))
897 898
		      (while (not (eobp))
			(case (char-after)
Juanma Barranquero's avatar
Juanma Barranquero committed
899
			  (?\s (insert " ") (setq modif nil) (backward-char 1))
900 901 902 903 904 905 906 907 908 909
			  (?- (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)))
910 911 912
                          ;; diff-valid-unified-empty-line.
                          (?\n (insert "  ") (setq modif nil) (backward-char 2)
                               (setq reversible nil))
913 914 915 916 917
			  (t (setq modif nil)))
			(let ((last-pt (point)))
			  (forward-line 1)
			  (when delete
			    (delete-region last-pt (point))
918 919 920 921 922 923 924 925 926
			    (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)))))))))))
927

928
(defun diff-context->unified (start end &optional to-context)
929
  "Convert context diffs to unified diffs.
930 931 932 933
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)
934
		   (list (region-beginning) (region-end) current-prefix-arg)
935 936 937
		 (list (point-min) (point-max) current-prefix-arg)))
  (if to-context
      (diff-unified->context start end)
938
    (unless (markerp end) (setq end (copy-marker end t)))
939
    (let ( ;;(diff-inhibit-after-change t)
Stefan Monnier's avatar
Stefan Monnier committed
940
          (inhibit-read-only t))
941
      (save-excursion
Stefan Monnier's avatar
Stefan Monnier committed
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965