]> code.delx.au - gnu-emacs/blob - lisp/vc/diff-mode.el
* vc/diff-mode.el (diff-mode-menu): diff-remove-trailing-whitespace.
[gnu-emacs] / lisp / vc / diff-mode.el
1 ;;; diff-mode.el --- a mode for viewing/editing context diffs -*- lexical-binding: t -*-
2
3 ;; Copyright (C) 1998-2012 Free Software Foundation, Inc.
4
5 ;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
6 ;; Keywords: convenience patch diff vc
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
22
23 ;;; Commentary:
24
25 ;; Provides support for font-lock, outline, navigation
26 ;; commands, editing and various conversions as well as jumping
27 ;; to the corresponding source file.
28
29 ;; Inspired by Pavel Machek's patch-mode.el (<pavel@@atrey.karlin.mff.cuni.cz>)
30 ;; Some efforts were spent to have it somewhat compatible with XEmacs's
31 ;; diff-mode as well as with compilation-minor-mode
32
33 ;; Bugs:
34
35 ;; - Reverse doesn't work with normal diffs.
36
37 ;; Todo:
38
39 ;; - Improve `diff-add-change-log-entries-other-window',
40 ;; it is very simplistic now.
41 ;;
42 ;; - Add a `delete-after-apply' so C-c C-a automatically deletes hunks.
43 ;; Also allow C-c C-a to delete already-applied hunks.
44 ;;
45 ;; - Try `diff <file> <hunk>' to try and fuzzily discover the source location
46 ;; of a hunk. Show then the changes between <file> and <hunk> and make it
47 ;; possible to apply them to <file>, <hunk-src>, or <hunk-dst>.
48 ;; 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 ;; - in diff-apply-hunk, strip context in replace-match to better
52 ;; preserve markers and spacing.
53 ;; - Handle `diff -b' output in context->unified.
54
55 ;;; Code:
56 (eval-when-compile (require 'cl-lib))
57
58 (defvar add-log-buffer-file-name-function)
59
60
61 (defgroup diff-mode ()
62 "Major mode for viewing/editing diffs."
63 :version "21.1"
64 :group 'tools
65 :group 'diff)
66
67 (defcustom diff-default-read-only nil
68 "If non-nil, `diff-mode' buffers default to being read-only."
69 :type 'boolean
70 :group 'diff-mode)
71
72 (defcustom diff-jump-to-old-file nil
73 "Non-nil means `diff-goto-source' jumps to the old file.
74 Else, it jumps to the new file."
75 :type 'boolean
76 :group 'diff-mode)
77
78 (defcustom diff-update-on-the-fly t
79 "Non-nil means hunk headers are kept up-to-date on-the-fly.
80 When editing a diff file, the line numbers in the hunk headers
81 need to be kept consistent with the actual diff. This can
82 either be done on the fly (but this sometimes interacts poorly with the
83 undo mechanism) or whenever the file is written (can be slow
84 when editing big diffs)."
85 :type 'boolean
86 :group 'diff-mode)
87
88 (defcustom diff-advance-after-apply-hunk t
89 "Non-nil means `diff-apply-hunk' will move to the next hunk after applying."
90 :type 'boolean
91 :group 'diff-mode)
92
93 (defcustom diff-mode-hook nil
94 "Run after setting up the `diff-mode' major mode."
95 :type 'hook
96 :options '(diff-delete-empty-files diff-make-unified)
97 :group 'diff-mode)
98
99 (defvar diff-vc-backend nil
100 "The VC backend that created the current Diff buffer, if any.")
101
102 (defvar diff-outline-regexp
103 "\\([*+][*+][*+] [^0-9]\\|@@ ...\\|\\*\\*\\* [0-9].\\|--- [0-9]..\\)")
104
105 ;;;;
106 ;;;; keymap, menu, ...
107 ;;;;
108
109 (easy-mmode-defmap diff-mode-shared-map
110 '(("n" . diff-hunk-next)
111 ("N" . diff-file-next)
112 ("p" . diff-hunk-prev)
113 ("P" . diff-file-prev)
114 ("\t" . diff-hunk-next)
115 ([backtab] . diff-hunk-prev)
116 ("k" . diff-hunk-kill)
117 ("K" . diff-file-kill)
118 ("}" . diff-file-next) ; From compilation-minor-mode.
119 ("{" . diff-file-prev)
120 ("\C-m" . diff-goto-source)
121 ([mouse-2] . diff-goto-source)
122 ("W" . widen)
123 ("o" . diff-goto-source) ; other-window
124 ("A" . diff-ediff-patch)
125 ("r" . diff-restrict-view)
126 ("R" . diff-reverse-direction)
127 ("/" . diff-undo)
128 ([remap undo] . diff-undo))
129 "Basic keymap for `diff-mode', bound to various prefix keys."
130 :inherit special-mode-map)
131
132 (easy-mmode-defmap diff-mode-map
133 `(("\e" . ,(let ((map (make-sparse-keymap)))
134 ;; We want to inherit most bindings from diff-mode-shared-map,
135 ;; but not all since they may hide useful M-<foo> global
136 ;; bindings when editing.
137 (set-keymap-parent map diff-mode-shared-map)
138 (dolist (key '("A" "r" "R" "g" "q" "W" "z"))
139 (define-key map key nil))
140 map))
141 ;; From compilation-minor-mode.
142 ("\C-c\C-c" . diff-goto-source)
143 ;; By analogy with the global C-x 4 a binding.
144 ("\C-x4A" . diff-add-change-log-entries-other-window)
145 ;; Misc operations.
146 ("\C-c\C-a" . diff-apply-hunk)
147 ("\C-c\C-e" . diff-ediff-patch)
148 ("\C-c\C-n" . diff-restrict-view)
149 ("\C-c\C-s" . diff-split-hunk)
150 ("\C-c\C-t" . diff-test-hunk)
151 ("\C-c\C-r" . diff-reverse-direction)
152 ("\C-c\C-u" . diff-context->unified)
153 ;; `d' because it duplicates the context :-( --Stef
154 ("\C-c\C-d" . diff-unified->context)
155 ("\C-c\C-w" . diff-ignore-whitespace-hunk)
156 ("\C-c\C-b" . diff-refine-hunk) ;No reason for `b' :-(
157 ("\C-c\C-f" . next-error-follow-minor-mode))
158 "Keymap for `diff-mode'. See also `diff-mode-shared-map'.")
159
160 (easy-menu-define diff-mode-menu diff-mode-map
161 "Menu for `diff-mode'."
162 '("Diff"
163 ["Jump to Source" diff-goto-source
164 :help "Jump to the corresponding source line"]
165 ["Apply hunk" diff-apply-hunk
166 :help "Apply the current hunk to the source file and go to the next"]
167 ["Test applying hunk" diff-test-hunk
168 :help "See whether it's possible to apply the current hunk"]
169 ["Apply diff with Ediff" diff-ediff-patch
170 :help "Call `ediff-patch-file' on the current buffer"]
171 ["Create Change Log entries" diff-add-change-log-entries-other-window
172 :help "Create ChangeLog entries for the changes in the diff buffer"]
173 "-----"
174 ["Reverse direction" diff-reverse-direction
175 :help "Reverse the direction of the diffs"]
176 ["Context -> Unified" diff-context->unified
177 :help "Convert context diffs to unified diffs"]
178 ["Unified -> Context" diff-unified->context
179 :help "Convert unified diffs to context diffs"]
180 ;;["Fixup Headers" diff-fixup-modifs (not buffer-read-only)]
181 ["Remove trailing whitespace" diff-remove-trailing-whitespace
182 :help "Remove trailing whitespace problems introduced by the diff"]
183 ["Show trailing whitespace" whitespace-mode
184 :style toggle :selected (bound-and-true-p whitespace-mode)
185 :help "Show trailing whitespace in modified lines"]
186 "-----"
187 ["Split hunk" diff-split-hunk
188 :active (diff-splittable-p)
189 :help "Split the current (unified diff) hunk at point into two hunks"]
190 ["Ignore whitespace changes" diff-ignore-whitespace-hunk
191 :help "Re-diff the current hunk, ignoring whitespace differences"]
192 ["Highlight fine changes" diff-refine-hunk
193 :help "Highlight changes of hunk at point at a finer granularity"]
194 ["Kill current hunk" diff-hunk-kill
195 :help "Kill current hunk"]
196 ["Kill current file's hunks" diff-file-kill
197 :help "Kill all current file's hunks"]
198 "-----"
199 ["Previous Hunk" diff-hunk-prev
200 :help "Go to the previous count'th hunk"]
201 ["Next Hunk" diff-hunk-next
202 :help "Go to the next count'th hunk"]
203 ["Previous File" diff-file-prev
204 :help "Go to the previous count'th file"]
205 ["Next File" diff-file-next
206 :help "Go to the next count'th file"]
207 ))
208
209 (defcustom diff-minor-mode-prefix "\C-c="
210 "Prefix key for `diff-minor-mode' commands."
211 :type '(choice (string "\e") (string "C-c=") string)
212 :group 'diff-mode)
213
214 (easy-mmode-defmap diff-minor-mode-map
215 `((,diff-minor-mode-prefix . ,diff-mode-shared-map))
216 "Keymap for `diff-minor-mode'. See also `diff-mode-shared-map'.")
217
218 (define-minor-mode diff-auto-refine-mode
219 "Toggle automatic diff hunk highlighting (Diff Auto Refine mode).
220 With a prefix argument ARG, enable Diff Auto Refine mode if ARG
221 is positive, and disable it otherwise. If called from Lisp,
222 enable the mode if ARG is omitted or nil.
223
224 Diff Auto Refine mode is a buffer-local minor mode used with
225 `diff-mode'. When enabled, Emacs automatically highlights
226 changes in detail as the user visits hunks. When transitioning
227 from disabled to enabled, it tries to refine the current hunk, as
228 well."
229 :group 'diff-mode :init-value t :lighter nil ;; " Auto-Refine"
230 (when diff-auto-refine-mode
231 (condition-case-unless-debug nil (diff-refine-hunk) (error nil))))
232
233 ;;;;
234 ;;;; font-lock support
235 ;;;;
236
237 (defface diff-header
238 '((((class color) (min-colors 88) (background light))
239 :background "grey80")
240 (((class color) (min-colors 88) (background dark))
241 :background "grey45")
242 (((class color))
243 :foreground "blue1" :weight bold)
244 (t :weight bold))
245 "`diff-mode' face inherited by hunk and index header faces."
246 :group 'diff-mode)
247 (define-obsolete-face-alias 'diff-header-face 'diff-header "22.1")
248 (defvar diff-header-face 'diff-header)
249
250 (defface diff-file-header
251 '((((class color) (min-colors 88) (background light))
252 :background "grey70" :weight bold)
253 (((class color) (min-colors 88) (background dark))
254 :background "grey60" :weight bold)
255 (((class color))
256 :foreground "cyan" :weight bold)
257 (t :weight bold)) ; :height 1.3
258 "`diff-mode' face used to highlight file header lines."
259 :group 'diff-mode)
260 (define-obsolete-face-alias 'diff-file-header-face 'diff-file-header "22.1")
261 (defvar diff-file-header-face 'diff-file-header)
262
263 (defface diff-index
264 '((t :inherit diff-file-header))
265 "`diff-mode' face used to highlight index header lines."
266 :group 'diff-mode)
267 (define-obsolete-face-alias 'diff-index-face 'diff-index "22.1")
268 (defvar diff-index-face 'diff-index)
269
270 (defface diff-hunk-header
271 '((t :inherit diff-header))
272 "`diff-mode' face used to highlight hunk header lines."
273 :group 'diff-mode)
274 (define-obsolete-face-alias 'diff-hunk-header-face 'diff-hunk-header "22.1")
275 (defvar diff-hunk-header-face 'diff-hunk-header)
276
277 (defface diff-removed
278 '((default
279 :inherit diff-changed)
280 (((class color) (min-colors 88) (background light))
281 :background "#ffdddd")
282 (((class color) (min-colors 88) (background dark))
283 :background "#553333")
284 (((class color))
285 :foreground "red"))
286 "`diff-mode' face used to highlight removed lines."
287 :group 'diff-mode)
288 (define-obsolete-face-alias 'diff-removed-face 'diff-removed "22.1")
289 (defvar diff-removed-face 'diff-removed)
290
291 (defface diff-added
292 '((default
293 :inherit diff-changed)
294 (((class color) (min-colors 88) (background light))
295 :background "#ddffdd")
296 (((class color) (min-colors 88) (background dark))
297 :background "#335533")
298 (((class color))
299 :foreground "green"))
300 "`diff-mode' face used to highlight added lines."
301 :group 'diff-mode)
302 (define-obsolete-face-alias 'diff-added-face 'diff-added "22.1")
303 (defvar diff-added-face 'diff-added)
304
305 (defface diff-changed
306 ;; We normally apply a `shadow'-based face on the `diff-context'
307 ;; face, and keep `diff-changed' the default.
308 '((((class color grayscale) (min-colors 88)))
309 ;; If the terminal lacks sufficient colors for shadowing,
310 ;; highlight changed lines explicitly.
311 (((class color))
312 :foreground "yellow"))
313 "`diff-mode' face used to highlight changed lines."
314 :group 'diff-mode)
315 (define-obsolete-face-alias 'diff-changed-face 'diff-changed "22.1")
316 (defvar diff-changed-face 'diff-changed)
317
318 (defface diff-indicator-removed
319 '((t :inherit diff-removed))
320 "`diff-mode' face used to highlight indicator of removed lines (-, <)."
321 :group 'diff-mode
322 :version "22.1")
323 (defvar diff-indicator-removed-face 'diff-indicator-removed)
324
325 (defface diff-indicator-added
326 '((t :inherit diff-added))
327 "`diff-mode' face used to highlight indicator of added lines (+, >)."
328 :group 'diff-mode
329 :version "22.1")
330 (defvar diff-indicator-added-face 'diff-indicator-added)
331
332 (defface diff-indicator-changed
333 '((t :inherit diff-changed))
334 "`diff-mode' face used to highlight indicator of changed lines."
335 :group 'diff-mode
336 :version "22.1")
337 (defvar diff-indicator-changed-face 'diff-indicator-changed)
338
339 (defface diff-function
340 '((t :inherit diff-header))
341 "`diff-mode' face used to highlight function names produced by \"diff -p\"."
342 :group 'diff-mode)
343 (define-obsolete-face-alias 'diff-function-face 'diff-function "22.1")
344 (defvar diff-function-face 'diff-function)
345
346 (defface diff-context
347 '((((class color grayscale) (min-colors 88)) :inherit shadow))
348 "`diff-mode' face used to highlight context and other side-information."
349 :group 'diff-mode)
350 (define-obsolete-face-alias 'diff-context-face 'diff-context "22.1")
351 (defvar diff-context-face 'diff-context)
352
353 (defface diff-nonexistent
354 '((t :inherit diff-file-header))
355 "`diff-mode' face used to highlight nonexistent files in recursive diffs."
356 :group 'diff-mode)
357 (define-obsolete-face-alias 'diff-nonexistent-face 'diff-nonexistent "22.1")
358 (defvar diff-nonexistent-face 'diff-nonexistent)
359
360 (defconst diff-yank-handler '(diff-yank-function))
361 (defun diff-yank-function (text)
362 ;; FIXME: the yank-handler is now called separately on each piece of text
363 ;; with a yank-handler property, so the next-single-property-change call
364 ;; below will always return nil :-( --stef
365 (let ((mixed (next-single-property-change 0 'yank-handler text))
366 (start (point)))
367 ;; First insert the text.
368 (insert text)
369 ;; If the text does not include any diff markers and if we're not
370 ;; yanking back into a diff-mode buffer, get rid of the prefixes.
371 (unless (or mixed (derived-mode-p 'diff-mode))
372 (undo-boundary) ; Just in case the user wanted the prefixes.
373 (let ((re (save-excursion
374 (if (re-search-backward "^[><!][ \t]" start t)
375 (if (eq (char-after) ?!)
376 "^[!+- ][ \t]" "^[<>][ \t]")
377 "^[ <>!+-]"))))
378 (save-excursion
379 (while (re-search-backward re start t)
380 (replace-match "" t t)))))))
381
382 (defconst diff-hunk-header-re-unified
383 "^@@ -\\([0-9]+\\)\\(?:,\\([0-9]+\\)\\)? \\+\\([0-9]+\\)\\(?:,\\([0-9]+\\)\\)? @@")
384 (defconst diff-context-mid-hunk-header-re
385 "--- \\([0-9]+\\)\\(?:,\\([0-9]+\\)\\)? ----$")
386
387 (defvar diff-use-changed-face (and (face-differs-from-default-p diff-changed-face)
388 (not (face-equal diff-changed-face diff-added-face))
389 (not (face-equal diff-changed-face diff-removed-face)))
390 "If non-nil, use the face `diff-changed' for changed lines in context diffs.
391 Otherwise, use the face `diff-removed' for removed lines,
392 and the face `diff-added' for added lines.")
393
394 (defvar diff-font-lock-keywords
395 `((,(concat "\\(" diff-hunk-header-re-unified "\\)\\(.*\\)$")
396 (1 diff-hunk-header-face) (6 diff-function-face))
397 ("^\\(\\*\\{15\\}\\)\\(.*\\)$" ;context
398 (1 diff-hunk-header-face) (2 diff-function-face))
399 ("^\\*\\*\\* .+ \\*\\*\\*\\*". diff-hunk-header-face) ;context
400 (,diff-context-mid-hunk-header-re . diff-hunk-header-face) ;context
401 ("^[0-9,]+[acd][0-9,]+$" . diff-hunk-header-face) ;normal
402 ("^---$" . diff-hunk-header-face) ;normal
403 ;; For file headers, accept files with spaces, but be careful to rule
404 ;; out false-positives when matching hunk headers.
405 ("^\\(---\\|\\+\\+\\+\\|\\*\\*\\*\\) \\([^\t\n]+?\\)\\(?:\t.*\\| \\(\\*\\*\\*\\*\\|----\\)\\)?\n"
406 (0 diff-header-face)
407 (2 (if (not (match-end 3)) diff-file-header-face) prepend))
408 ("^\\([-<]\\)\\(.*\n\\)"
409 (1 diff-indicator-removed-face) (2 diff-removed-face))
410 ("^\\([+>]\\)\\(.*\n\\)"
411 (1 diff-indicator-added-face) (2 diff-added-face))
412 ("^\\(!\\)\\(.*\n\\)"
413 (1 (if diff-use-changed-face
414 diff-indicator-changed-face
415 ;; Otherwise, search for `diff-context-mid-hunk-header-re' and
416 ;; if the line of context diff is above, use `diff-removed-face';
417 ;; if below, use `diff-added-face'.
418 (save-match-data
419 (let ((limit (save-excursion (diff-beginning-of-hunk))))
420 (if (save-excursion (re-search-backward diff-context-mid-hunk-header-re limit t))
421 diff-indicator-added-face
422 diff-indicator-removed-face)))))
423 (2 (if diff-use-changed-face
424 diff-changed-face
425 ;; Otherwise, use the same method as above.
426 (save-match-data
427 (let ((limit (save-excursion (diff-beginning-of-hunk))))
428 (if (save-excursion (re-search-backward diff-context-mid-hunk-header-re limit t))
429 diff-added-face
430 diff-removed-face))))))
431 ("^\\(?:Index\\|revno\\): \\(.+\\).*\n"
432 (0 diff-header-face) (1 diff-index-face prepend))
433 ("^Only in .*\n" . diff-nonexistent-face)
434 ("^\\(#\\)\\(.*\\)"
435 (1 font-lock-comment-delimiter-face)
436 (2 font-lock-comment-face))
437 ("^[^-=+*!<>#].*\n" (0 diff-context-face))))
438
439 (defconst diff-font-lock-defaults
440 '(diff-font-lock-keywords t nil nil nil (font-lock-multiline . nil)))
441
442 (defvar diff-imenu-generic-expression
443 ;; Prefer second name as first is most likely to be a backup or
444 ;; version-control name. The [\t\n] at the end of the unidiff pattern
445 ;; catches Debian source diff files (which lack the trailing date).
446 '((nil "\\+\\+\\+\\ \\([^\t\n]+\\)[\t\n]" 1) ; unidiffs
447 (nil "^--- \\([^\t\n]+\\)\t.*\n\\*" 1))) ; context diffs
448
449 ;;;;
450 ;;;; Movement
451 ;;;;
452
453 (defvar diff-valid-unified-empty-line t
454 "If non-nil, empty lines are valid in unified diffs.
455 Some versions of diff replace all-blank context lines in unified format with
456 empty lines. This makes the format less robust, but is tolerated.
457 See http://lists.gnu.org/archive/html/emacs-devel/2007-11/msg01990.html")
458
459 (defconst diff-hunk-header-re
460 (concat "^\\(?:" diff-hunk-header-re-unified ".*\\|\\*\\{15\\}.*\n\\*\\*\\* .+ \\*\\*\\*\\*\\|[0-9]+\\(,[0-9]+\\)?[acd][0-9]+\\(,[0-9]+\\)?\\)$"))
461 (defconst diff-file-header-re (concat "^\\(--- .+\n\\+\\+\\+ \\|\\*\\*\\* .+\n--- \\|[^-+!<>0-9@* \n]\\).+\n" (substring diff-hunk-header-re 1)))
462 (defvar diff-narrowed-to nil)
463
464 (defun diff-hunk-style (&optional style)
465 (when (looking-at diff-hunk-header-re)
466 (setq style (cdr (assq (char-after) '((?@ . unified) (?* . context)))))
467 (goto-char (match-end 0)))
468 style)
469
470 (defun diff-end-of-hunk (&optional style donttrustheader)
471 "Advance to the end of the current hunk, and return its position."
472 (let (end)
473 (when (looking-at diff-hunk-header-re)
474 ;; Especially important for unified (because headers are ambiguous).
475 (setq style (diff-hunk-style style))
476 (goto-char (match-end 0))
477 (when (and (not donttrustheader) (match-end 2))
478 (let* ((nold (string-to-number (or (match-string 2) "1")))
479 (nnew (string-to-number (or (match-string 4) "1")))
480 (endold
481 (save-excursion
482 (re-search-forward (if diff-valid-unified-empty-line
483 "^[- \n]" "^[- ]")
484 nil t nold)
485 (line-beginning-position 2)))
486 (endnew
487 ;; The hunk may end with a bunch of "+" lines, so the `end' is
488 ;; then further than computed above.
489 (save-excursion
490 (re-search-forward (if diff-valid-unified-empty-line
491 "^[+ \n]" "^[+ ]")
492 nil t nnew)
493 (line-beginning-position 2))))
494 (setq end (max endold endnew)))))
495 ;; We may have a first evaluation of `end' thanks to the hunk header.
496 (unless end
497 (setq end (and (re-search-forward
498 (pcase style
499 (`unified
500 (concat (if diff-valid-unified-empty-line
501 "^[^-+# \\\n]\\|" "^[^-+# \\]\\|")
502 ;; A `unified' header is ambiguous.
503 diff-file-header-re))
504 (`context "^[^-+#! \\]")
505 (`normal "^[^<>#\\]")
506 (_ "^[^-+#!<> \\]"))
507 nil t)
508 (match-beginning 0)))
509 (when diff-valid-unified-empty-line
510 ;; While empty lines may be valid inside hunks, they are also likely
511 ;; to be unrelated to the hunk.
512 (goto-char (or end (point-max)))
513 (while (eq ?\n (char-before (1- (point))))
514 (forward-char -1)
515 (setq end (point)))))
516 ;; The return value is used by easy-mmode-define-navigation.
517 (goto-char (or end (point-max)))))
518
519 (defun diff-beginning-of-hunk (&optional try-harder)
520 "Move back to the previous hunk beginning, and return its position.
521 If point is in a file header rather than a hunk, advance to the
522 next hunk if TRY-HARDER is non-nil; otherwise signal an error."
523 (beginning-of-line)
524 (if (looking-at diff-hunk-header-re)
525 (point)
526 (forward-line 1)
527 (condition-case ()
528 (re-search-backward diff-hunk-header-re)
529 (error
530 (unless try-harder
531 (error "Can't find the beginning of the hunk"))
532 (diff-beginning-of-file-and-junk)
533 (diff-hunk-next)
534 (point)))))
535
536 (defun diff-unified-hunk-p ()
537 (save-excursion
538 (ignore-errors
539 (diff-beginning-of-hunk)
540 (looking-at "^@@"))))
541
542 (defun diff-beginning-of-file ()
543 (beginning-of-line)
544 (unless (looking-at diff-file-header-re)
545 (let ((start (point))
546 res)
547 ;; diff-file-header-re may need to match up to 4 lines, so in case
548 ;; we're inside the header, we need to move up to 3 lines forward.
549 (forward-line 3)
550 (if (and (setq res (re-search-backward diff-file-header-re nil t))
551 ;; Maybe the 3 lines forward were too much and we matched
552 ;; a file header after our starting point :-(
553 (or (<= (point) start)
554 (setq res (re-search-backward diff-file-header-re nil t))))
555 res
556 (goto-char start)
557 (error "Can't find the beginning of the file")))))
558
559
560 (defun diff-end-of-file ()
561 (re-search-forward "^[-+#!<>0-9@* \\]" nil t)
562 (re-search-forward (concat "^[^-+#!<>0-9@* \\]\\|" diff-file-header-re)
563 nil 'move)
564 (if (match-beginning 1)
565 (goto-char (match-beginning 1))
566 (beginning-of-line)))
567
568 ;; Define diff-{hunk,file}-{prev,next}
569 (easy-mmode-define-navigation
570 diff-hunk diff-hunk-header-re "hunk" diff-end-of-hunk diff-restrict-view
571 (if diff-auto-refine-mode
572 (condition-case-unless-debug nil (diff-refine-hunk) (error nil))))
573
574 (easy-mmode-define-navigation
575 diff-file diff-file-header-re "file" diff-end-of-file)
576
577 (defun diff-bounds-of-hunk ()
578 "Return the bounds of the diff hunk at point.
579 The return value is a list (BEG END), which are the hunk's start
580 and end positions. Signal an error if no hunk is found. If
581 point is in a file header, return the bounds of the next hunk."
582 (save-excursion
583 (let ((pos (point))
584 (beg (diff-beginning-of-hunk t))
585 (end (diff-end-of-hunk)))
586 (cond ((>= end pos)
587 (list beg end))
588 ;; If this hunk ends above POS, consider the next hunk.
589 ((re-search-forward diff-hunk-header-re nil t)
590 (list (match-beginning 0) (diff-end-of-hunk)))
591 (t (error "No hunk found"))))))
592
593 (defun diff-bounds-of-file ()
594 "Return the bounds of the file segment at point.
595 The return value is a list (BEG END), which are the segment's
596 start and end positions."
597 (save-excursion
598 (let ((pos (point))
599 (beg (progn (diff-beginning-of-file-and-junk)
600 (point))))
601 (diff-end-of-file)
602 ;; bzr puts a newline after the last hunk.
603 (while (looking-at "^\n")
604 (forward-char 1))
605 (if (> pos (point))
606 (error "Not inside a file diff"))
607 (list beg (point)))))
608
609 (defun diff-restrict-view (&optional arg)
610 "Restrict the view to the current hunk.
611 If the prefix ARG is given, restrict the view to the current file instead."
612 (interactive "P")
613 (apply 'narrow-to-region
614 (if arg (diff-bounds-of-file) (diff-bounds-of-hunk)))
615 (set (make-local-variable 'diff-narrowed-to) (if arg 'file 'hunk)))
616
617 (defun diff-hunk-kill ()
618 "Kill the hunk at point."
619 (interactive)
620 (let* ((hunk-bounds (diff-bounds-of-hunk))
621 (file-bounds (ignore-errors (diff-bounds-of-file)))
622 ;; If the current hunk is the only one for its file, kill the
623 ;; file header too.
624 (bounds (if (and file-bounds
625 (progn (goto-char (car file-bounds))
626 (= (progn (diff-hunk-next) (point))
627 (car hunk-bounds)))
628 (progn (goto-char (cadr hunk-bounds))
629 ;; bzr puts a newline after the last hunk.
630 (while (looking-at "^\n")
631 (forward-char 1))
632 (= (point) (cadr file-bounds))))
633 file-bounds
634 hunk-bounds))
635 (inhibit-read-only t))
636 (apply 'kill-region bounds)
637 (goto-char (car bounds))))
638
639 ;; "index ", "old mode", "new mode", "new file mode" and
640 ;; "deleted file mode" are output by git-diff.
641 (defconst diff-file-junk-re
642 "diff \\|index \\|\\(?:deleted file\\|new\\(?: file\\)?\\|old\\) mode\\|=== modified file")
643
644 (defun diff-beginning-of-file-and-junk ()
645 "Go to the beginning of file-related diff-info.
646 This is like `diff-beginning-of-file' except it tries to skip back over leading
647 data such as \"Index: ...\" and such."
648 (let* ((orig (point))
649 ;; Skip forward over what might be "leading junk" so as to get
650 ;; closer to the actual diff.
651 (_ (progn (beginning-of-line)
652 (while (looking-at diff-file-junk-re)
653 (forward-line 1))))
654 (start (point))
655 (prevfile (condition-case err
656 (save-excursion (diff-beginning-of-file) (point))
657 (error err)))
658 (err (if (consp prevfile) prevfile))
659 (nextfile (ignore-errors
660 (save-excursion
661 (goto-char start) (diff-file-next) (point))))
662 ;; prevhunk is one of the limits.
663 (prevhunk (save-excursion
664 (ignore-errors
665 (if (numberp prevfile) (goto-char prevfile))
666 (diff-hunk-prev) (point))))
667 (previndex (save-excursion
668 (forward-line 1) ;In case we're looking at "Index:".
669 (re-search-backward "^Index: " prevhunk t))))
670 ;; If we're in the junk, we should use nextfile instead of prevfile.
671 (if (and (numberp nextfile)
672 (or (not (numberp prevfile))
673 (and previndex (> previndex prevfile))))
674 (setq prevfile nextfile))
675 (if (and previndex (numberp prevfile) (< previndex prevfile))
676 (setq prevfile previndex))
677 (if (and (numberp prevfile) (<= prevfile start))
678 (progn
679 (goto-char prevfile)
680 ;; Now skip backward over the leading junk we may have before the
681 ;; diff itself.
682 (while (save-excursion
683 (and (zerop (forward-line -1))
684 (looking-at diff-file-junk-re)))
685 (forward-line -1)))
686 ;; File starts *after* the starting point: we really weren't in
687 ;; a file diff but elsewhere.
688 (goto-char orig)
689 (signal (car err) (cdr err)))))
690
691 (defun diff-file-kill ()
692 "Kill current file's hunks."
693 (interactive)
694 (let ((inhibit-read-only t))
695 (apply 'kill-region (diff-bounds-of-file))))
696
697 (defun diff-kill-junk ()
698 "Kill spurious empty diffs."
699 (interactive)
700 (save-excursion
701 (let ((inhibit-read-only t))
702 (goto-char (point-min))
703 (while (re-search-forward (concat "^\\(Index: .*\n\\)"
704 "\\([^-+!* <>].*\n\\)*?"
705 "\\(\\(Index:\\) \\|"
706 diff-file-header-re "\\)")
707 nil t)
708 (delete-region (if (match-end 4) (match-beginning 0) (match-end 1))
709 (match-beginning 3))
710 (beginning-of-line)))))
711
712 (defun diff-count-matches (re start end)
713 (save-excursion
714 (let ((n 0))
715 (goto-char start)
716 (while (re-search-forward re end t) (cl-incf n))
717 n)))
718
719 (defun diff-splittable-p ()
720 (save-excursion
721 (beginning-of-line)
722 (and (looking-at "^[-+ ]")
723 (progn (forward-line -1) (looking-at "^[-+ ]"))
724 (diff-unified-hunk-p))))
725
726 (defun diff-split-hunk ()
727 "Split the current (unified diff) hunk at point into two hunks."
728 (interactive)
729 (beginning-of-line)
730 (let ((pos (point))
731 (start (diff-beginning-of-hunk)))
732 (unless (looking-at diff-hunk-header-re-unified)
733 (error "diff-split-hunk only works on unified context diffs"))
734 (forward-line 1)
735 (let* ((start1 (string-to-number (match-string 1)))
736 (start2 (string-to-number (match-string 3)))
737 (newstart1 (+ start1 (diff-count-matches "^[- \t]" (point) pos)))
738 (newstart2 (+ start2 (diff-count-matches "^[+ \t]" (point) pos)))
739 (inhibit-read-only t))
740 (goto-char pos)
741 ;; Hopefully the after-change-function will not screw us over.
742 (insert "@@ -" (number-to-string newstart1) ",1 +"
743 (number-to-string newstart2) ",1 @@\n")
744 ;; Fix the original hunk-header.
745 (diff-fixup-modifs start pos))))
746
747
748 ;;;;
749 ;;;; jump to other buffers
750 ;;;;
751
752 (defvar diff-remembered-files-alist nil)
753 (defvar diff-remembered-defdir nil)
754
755 (defun diff-filename-drop-dir (file)
756 (when (string-match "/" file) (substring file (match-end 0))))
757
758 (defun diff-merge-strings (ancestor from to)
759 "Merge the diff between ANCESTOR and FROM into TO.
760 Returns the merged string if successful or nil otherwise.
761 The strings are assumed not to contain any \"\\n\" (i.e. end of line).
762 If ANCESTOR = FROM, returns TO.
763 If ANCESTOR = TO, returns FROM.
764 The heuristic is simplistic and only really works for cases
765 like \(diff-merge-strings \"b/foo\" \"b/bar\" \"/a/c/foo\")."
766 ;; Ideally, we want:
767 ;; AMB ANB CMD -> CND
768 ;; but that's ambiguous if `foo' or `bar' is empty:
769 ;; a/foo a/foo1 b/foo.c -> b/foo1.c but not 1b/foo.c or b/foo.c1
770 (let ((str (concat ancestor "\n" from "\n" to)))
771 (when (and (string-match (concat
772 "\\`\\(.*?\\)\\(.*\\)\\(.*\\)\n"
773 "\\1\\(.*\\)\\3\n"
774 "\\(.*\\(\\2\\).*\\)\\'") str)
775 (equal to (match-string 5 str)))
776 (concat (substring str (match-beginning 5) (match-beginning 6))
777 (match-string 4 str)
778 (substring str (match-end 6) (match-end 5))))))
779
780 (defun diff-tell-file-name (old name)
781 "Tell Emacs where the find the source file of the current hunk.
782 If the OLD prefix arg is passed, tell the file NAME of the old file."
783 (interactive
784 (let* ((old current-prefix-arg)
785 (fs (diff-hunk-file-names current-prefix-arg)))
786 (unless fs (error "No file name to look for"))
787 (list old (read-file-name (format "File for %s: " (car fs))
788 nil (diff-find-file-name old 'noprompt) t))))
789 (let ((fs (diff-hunk-file-names old)))
790 (unless fs (error "No file name to look for"))
791 (push (cons fs name) diff-remembered-files-alist)))
792
793 (defun diff-hunk-file-names (&optional old)
794 "Give the list of file names textually mentioned for the current hunk."
795 (save-excursion
796 (unless (looking-at diff-file-header-re)
797 (or (ignore-errors (diff-beginning-of-file))
798 (re-search-forward diff-file-header-re nil t)))
799 (let ((limit (save-excursion
800 (condition-case ()
801 (progn (diff-hunk-prev) (point))
802 (error (point-min)))))
803 (header-files
804 (if (looking-at "[-*][-*][-*] \\(\\S-+\\)\\(\\s-.*\\)?\n[-+][-+][-+] \\(\\S-+\\)")
805 (list (if old (match-string 1) (match-string 3))
806 (if old (match-string 3) (match-string 1)))
807 (forward-line 1) nil)))
808 (delq nil
809 (append
810 (when (and (not old)
811 (save-excursion
812 (re-search-backward "^Index: \\(.+\\)" limit t)))
813 (list (match-string 1)))
814 header-files
815 (when (re-search-backward
816 "^diff \\(-\\S-+ +\\)*\\(\\S-+\\)\\( +\\(\\S-+\\)\\)?"
817 nil t)
818 (list (if old (match-string 2) (match-string 4))
819 (if old (match-string 4) (match-string 2)))))))))
820
821 (defun diff-find-file-name (&optional old noprompt prefix)
822 "Return the file corresponding to the current patch.
823 Non-nil OLD means that we want the old file.
824 Non-nil NOPROMPT means to prefer returning nil than to prompt the user.
825 PREFIX is only used internally: don't use it."
826 (unless (equal diff-remembered-defdir default-directory)
827 ;; Flush diff-remembered-files-alist if the default-directory is changed.
828 (set (make-local-variable 'diff-remembered-defdir) default-directory)
829 (set (make-local-variable 'diff-remembered-files-alist) nil))
830 (save-excursion
831 (unless (looking-at diff-file-header-re)
832 (or (ignore-errors (diff-beginning-of-file))
833 (re-search-forward diff-file-header-re nil t)))
834 (let ((fs (diff-hunk-file-names old)))
835 (if prefix (setq fs (mapcar (lambda (f) (concat prefix f)) fs)))
836 (or
837 ;; use any previously used preference
838 (cdr (assoc fs diff-remembered-files-alist))
839 ;; try to be clever and use previous choices as an inspiration
840 (cl-dolist (rf diff-remembered-files-alist)
841 (let ((newfile (diff-merge-strings (caar rf) (car fs) (cdr rf))))
842 (if (and newfile (file-exists-p newfile)) (cl-return newfile))))
843 ;; look for each file in turn. If none found, try again but
844 ;; ignoring the first level of directory, ...
845 (cl-do* ((files fs (delq nil (mapcar 'diff-filename-drop-dir files)))
846 (file nil nil))
847 ((or (null files)
848 (setq file (cl-do* ((files files (cdr files))
849 (file (car files) (car files)))
850 ;; Use file-regular-p to avoid
851 ;; /dev/null, directories, etc.
852 ((or (null file) (file-regular-p file))
853 file))))
854 file))
855 ;; <foo>.rej patches implicitly apply to <foo>
856 (and (string-match "\\.rej\\'" (or buffer-file-name ""))
857 (let ((file (substring buffer-file-name 0 (match-beginning 0))))
858 (when (file-exists-p file) file)))
859 ;; If we haven't found the file, maybe it's because we haven't paid
860 ;; attention to the PCL-CVS hint.
861 (and (not prefix)
862 (boundp 'cvs-pcl-cvs-dirchange-re)
863 (save-excursion
864 (re-search-backward cvs-pcl-cvs-dirchange-re nil t))
865 (diff-find-file-name old noprompt (match-string 1)))
866 ;; if all else fails, ask the user
867 (unless noprompt
868 (let ((file (expand-file-name (or (car fs) ""))))
869 (setq file
870 (read-file-name (format "Use file %s: " file)
871 (file-name-directory file) file t
872 (file-name-nondirectory file)))
873 (set (make-local-variable 'diff-remembered-files-alist)
874 (cons (cons fs file) diff-remembered-files-alist))
875 file))))))
876
877
878 (defun diff-ediff-patch ()
879 "Call `ediff-patch-file' on the current buffer."
880 (interactive)
881 (condition-case nil
882 (ediff-patch-file nil (current-buffer))
883 (wrong-number-of-arguments (ediff-patch-file))))
884
885 ;;;;
886 ;;;; Conversion functions
887 ;;;;
888
889 ;;(defvar diff-inhibit-after-change nil
890 ;; "Non-nil means inhibit `diff-mode's after-change functions.")
891
892 (defun diff-unified->context (start end)
893 "Convert unified diffs to context diffs.
894 START and END are either taken from the region (if a prefix arg is given) or
895 else cover the whole buffer."
896 (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
897 (list (region-beginning) (region-end))
898 (list (point-min) (point-max))))
899 (unless (markerp end) (setq end (copy-marker end t)))
900 (let (;;(diff-inhibit-after-change t)
901 (inhibit-read-only t))
902 (save-excursion
903 (goto-char start)
904 (while (and (re-search-forward
905 (concat "^\\(\\(---\\) .+\n\\(\\+\\+\\+\\) .+\\|"
906 diff-hunk-header-re-unified ".*\\)$")
907 nil t)
908 (< (point) end))
909 (combine-after-change-calls
910 (if (match-beginning 2)
911 ;; we matched a file header
912 (progn
913 ;; use reverse order to make sure the indices are kept valid
914 (replace-match "---" t t nil 3)
915 (replace-match "***" t t nil 2))
916 ;; we matched a hunk header
917 (let ((line1 (match-string 4))
918 (lines1 (or (match-string 5) "1"))
919 (line2 (match-string 6))
920 (lines2 (or (match-string 7) "1"))
921 ;; Variables to use the special undo function.
922 (old-undo buffer-undo-list)
923 (old-end (marker-position end))
924 (start (match-beginning 0))
925 (reversible t))
926 (replace-match
927 (concat "***************\n*** " line1 ","
928 (number-to-string (+ (string-to-number line1)
929 (string-to-number lines1)
930 -1))
931 " ****"))
932 (save-restriction
933 (narrow-to-region (line-beginning-position 2)
934 ;; Call diff-end-of-hunk from just before
935 ;; the hunk header so it can use the hunk
936 ;; header info.
937 (progn (diff-end-of-hunk 'unified) (point)))
938 (let ((hunk (buffer-string)))
939 (goto-char (point-min))
940 (if (not (save-excursion (re-search-forward "^-" nil t)))
941 (delete-region (point) (point-max))
942 (goto-char (point-max))
943 (let ((modif nil) last-pt)
944 (while (progn (setq last-pt (point))
945 (= (forward-line -1) 0))
946 (pcase (char-after)
947 (?\s (insert " ") (setq modif nil) (backward-char 1))
948 (?+ (delete-region (point) last-pt) (setq modif t))
949 (?- (if (not modif)
950 (progn (forward-char 1)
951 (insert " "))
952 (delete-char 1)
953 (insert "! "))
954 (backward-char 2))
955 (?\\ (when (save-excursion (forward-line -1)
956 (= (char-after) ?+))
957 (delete-region (point) last-pt)
958 (setq modif t)))
959 ;; diff-valid-unified-empty-line.
960 (?\n (insert " ") (setq modif nil)
961 (backward-char 2))
962 (_ (setq modif nil))))))
963 (goto-char (point-max))
964 (save-excursion
965 (insert "--- " line2 ","
966 (number-to-string (+ (string-to-number line2)
967 (string-to-number lines2)
968 -1))
969 " ----\n" hunk))
970 ;;(goto-char (point-min))
971 (forward-line 1)
972 (if (not (save-excursion (re-search-forward "^+" nil t)))
973 (delete-region (point) (point-max))
974 (let ((modif nil) (delete nil))
975 (if (save-excursion (re-search-forward "^\\+.*\n-"
976 nil t))
977 ;; Normally, lines in a substitution come with
978 ;; first the removals and then the additions, and
979 ;; the context->unified function follows this
980 ;; convention, of course. Yet, other alternatives
981 ;; are valid as well, but they preclude the use of
982 ;; context->unified as an undo command.
983 (setq reversible nil))
984 (while (not (eobp))
985 (pcase (char-after)
986 (?\s (insert " ") (setq modif nil) (backward-char 1))
987 (?- (setq delete t) (setq modif t))
988 (?+ (if (not modif)
989 (progn (forward-char 1)
990 (insert " "))
991 (delete-char 1)
992 (insert "! "))
993 (backward-char 2))
994 (?\\ (when (save-excursion (forward-line 1)
995 (not (eobp)))
996 (setq delete t) (setq modif t)))
997 ;; diff-valid-unified-empty-line.
998 (?\n (insert " ") (setq modif nil) (backward-char 2)
999 (setq reversible nil))
1000 (_ (setq modif nil)))
1001 (let ((last-pt (point)))
1002 (forward-line 1)
1003 (when delete
1004 (delete-region last-pt (point))
1005 (setq delete nil)))))))
1006 (unless (or (not reversible) (eq buffer-undo-list t))
1007 ;; Drop the many undo entries and replace them with
1008 ;; a single entry that uses diff-context->unified to do
1009 ;; the work.
1010 (setq buffer-undo-list
1011 (cons (list 'apply (- old-end end) start (point-max)
1012 'diff-context->unified start (point-max))
1013 old-undo)))))))))))
1014
1015 (defun diff-context->unified (start end &optional to-context)
1016 "Convert context diffs to unified diffs.
1017 START and END are either taken from the region
1018 \(when it is highlighted) or else cover the whole buffer.
1019 With a prefix argument, convert unified format to context format."
1020 (interactive (if (and transient-mark-mode mark-active)
1021 (list (region-beginning) (region-end) current-prefix-arg)
1022 (list (point-min) (point-max) current-prefix-arg)))
1023 (if to-context
1024 (diff-unified->context start end)
1025 (unless (markerp end) (setq end (copy-marker end t)))
1026 (let ( ;;(diff-inhibit-after-change t)
1027 (inhibit-read-only t))
1028 (save-excursion
1029 (goto-char start)
1030 (while (and (re-search-forward "^\\(\\(\\*\\*\\*\\) .+\n\\(---\\) .+\\|\\*\\{15\\}.*\n\\*\\*\\* \\([0-9]+\\),\\(-?[0-9]+\\) \\*\\*\\*\\*\\)$" nil t)
1031 (< (point) end))
1032 (combine-after-change-calls
1033 (if (match-beginning 2)
1034 ;; we matched a file header
1035 (progn
1036 ;; use reverse order to make sure the indices are kept valid
1037 (replace-match "+++" t t nil 3)
1038 (replace-match "---" t t nil 2))
1039 ;; we matched a hunk header
1040 (let ((line1s (match-string 4))
1041 (line1e (match-string 5))
1042 (pt1 (match-beginning 0))
1043 ;; Variables to use the special undo function.
1044 (old-undo buffer-undo-list)
1045 (old-end (marker-position end))
1046 (reversible t))
1047 (replace-match "")
1048 (unless (re-search-forward
1049 diff-context-mid-hunk-header-re nil t)
1050 (error "Can't find matching `--- n1,n2 ----' line"))
1051 (let ((line2s (match-string 1))
1052 (line2e (match-string 2))
1053 (pt2 (progn
1054 (delete-region (progn (beginning-of-line) (point))
1055 (progn (forward-line 1) (point)))
1056 (point-marker))))
1057 (goto-char pt1)
1058 (forward-line 1)
1059 (while (< (point) pt2)
1060 (pcase (char-after)
1061 (?! (delete-char 2) (insert "-") (forward-line 1))
1062 (?- (forward-char 1) (delete-char 1) (forward-line 1))
1063 (?\s ;merge with the other half of the chunk
1064 (let* ((endline2
1065 (save-excursion
1066 (goto-char pt2) (forward-line 1) (point))))
1067 (pcase (char-after pt2)
1068 ((or ?! ?+)
1069 (insert "+"
1070 (prog1
1071 (buffer-substring (+ pt2 2) endline2)
1072 (delete-region pt2 endline2))))
1073 (?\s
1074 (unless (= (- endline2 pt2)
1075 (- (line-beginning-position 2) (point)))
1076 ;; If the two lines we're merging don't have the
1077 ;; same length (can happen with "diff -b"), then
1078 ;; diff-unified->context will not properly undo
1079 ;; this operation.
1080 (setq reversible nil))
1081 (delete-region pt2 endline2)
1082 (delete-char 1)
1083 (forward-line 1))
1084 (?\\ (forward-line 1))
1085 (_ (setq reversible nil)
1086 (delete-char 1) (forward-line 1)))))
1087 (_ (setq reversible nil) (forward-line 1))))
1088 (while (looking-at "[+! ] ")
1089 (if (/= (char-after) ?!) (forward-char 1)
1090 (delete-char 1) (insert "+"))
1091 (delete-char 1) (forward-line 1))
1092 (save-excursion
1093 (goto-char pt1)
1094 (insert "@@ -" line1s ","
1095 (number-to-string (- (string-to-number line1e)
1096 (string-to-number line1s)
1097 -1))
1098 " +" line2s ","
1099 (number-to-string (- (string-to-number line2e)
1100 (string-to-number line2s)
1101 -1)) " @@"))
1102 (set-marker pt2 nil)
1103 ;; The whole procedure succeeded, let's replace the myriad
1104 ;; of undo elements with just a single special one.
1105 (unless (or (not reversible) (eq buffer-undo-list t))
1106 (setq buffer-undo-list
1107 (cons (list 'apply (- old-end end) pt1 (point)
1108 'diff-unified->context pt1 (point))
1109 old-undo)))
1110 )))))))))
1111
1112 (defun diff-reverse-direction (start end)
1113 "Reverse the direction of the diffs.
1114 START and END are either taken from the region (if a prefix arg is given) or
1115 else cover the whole buffer."
1116 (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
1117 (list (region-beginning) (region-end))
1118 (list (point-min) (point-max))))
1119 (unless (markerp end) (setq end (copy-marker end t)))
1120 (let (;;(diff-inhibit-after-change t)
1121 (inhibit-read-only t))
1122 (save-excursion
1123 (goto-char start)
1124 (while (and (re-search-forward "^\\(\\([-*][-*][-*] \\)\\(.+\\)\n\\([-+][-+][-+] \\)\\(.+\\)\\|\\*\\{15\\}.*\n\\*\\*\\* \\(.+\\) \\*\\*\\*\\*\\|@@ -\\([0-9,]+\\) \\+\\([0-9,]+\\) @@.*\\)$" nil t)
1125 (< (point) end))
1126 (combine-after-change-calls
1127 (cond
1128 ;; a file header
1129 ((match-beginning 2) (replace-match "\\2\\5\n\\4\\3" nil))
1130 ;; a context-diff hunk header
1131 ((match-beginning 6)
1132 (let ((pt-lines1 (match-beginning 6))
1133 (lines1 (match-string 6)))
1134 (replace-match "" nil nil nil 6)
1135 (forward-line 1)
1136 (let ((half1s (point)))
1137 (while (looking-at "[-! \\][ \t]\\|#")
1138 (when (= (char-after) ?-) (delete-char 1) (insert "+"))
1139 (forward-line 1))
1140 (let ((half1 (delete-and-extract-region half1s (point))))
1141 (unless (looking-at diff-context-mid-hunk-header-re)
1142 (insert half1)
1143 (error "Can't find matching `--- n1,n2 ----' line"))
1144 (let* ((str1end (or (match-end 2) (match-end 1)))
1145 (str1 (buffer-substring (match-beginning 1) str1end)))
1146 (goto-char str1end)
1147 (insert lines1)
1148 (delete-region (match-beginning 1) str1end)
1149 (forward-line 1)
1150 (let ((half2s (point)))
1151 (while (looking-at "[!+ \\][ \t]\\|#")
1152 (when (= (char-after) ?+) (delete-char 1) (insert "-"))
1153 (forward-line 1))
1154 (let ((half2 (delete-and-extract-region half2s (point))))
1155 (insert (or half1 ""))
1156 (goto-char half1s)
1157 (insert (or half2 ""))))
1158 (goto-char pt-lines1)
1159 (insert str1))))))
1160 ;; a unified-diff hunk header
1161 ((match-beginning 7)
1162 (replace-match "@@ -\\8 +\\7 @@" nil)
1163 (forward-line 1)
1164 (let ((c (char-after)) first last)
1165 (while (pcase (setq c (char-after))
1166 (?- (setq first (or first (point)))
1167 (delete-char 1) (insert "+") t)
1168 (?+ (setq last (or last (point)))
1169 (delete-char 1) (insert "-") t)
1170 ((or ?\\ ?#) t)
1171 (_ (when (and first last (< first last))
1172 (insert (delete-and-extract-region first last)))
1173 (setq first nil last nil)
1174 (memq c (if diff-valid-unified-empty-line
1175 '(?\s ?\n) '(?\s)))))
1176 (forward-line 1))))))))))
1177
1178 (defun diff-fixup-modifs (start end)
1179 "Fixup the hunk headers (in case the buffer was modified).
1180 START and END are either taken from the region (if a prefix arg is given) or
1181 else cover the whole buffer."
1182 (interactive (if (or current-prefix-arg (and transient-mark-mode mark-active))
1183 (list (region-beginning) (region-end))
1184 (list (point-min) (point-max))))
1185 (let ((inhibit-read-only t))
1186 (save-excursion
1187 (goto-char end) (diff-end-of-hunk nil 'donttrustheader)
1188 (let ((plus 0) (minus 0) (space 0) (bang 0))
1189 (while (and (= (forward-line -1) 0) (<= start (point)))
1190 (if (not (looking-at
1191 (concat diff-hunk-header-re-unified
1192 "\\|[-*][-*][-*] [0-9,]+ [-*][-*][-*][-*]$"
1193 "\\|--- .+\n\\+\\+\\+ ")))
1194 (pcase (char-after)
1195 (?\s (cl-incf space))
1196 (?+ (cl-incf plus))
1197 (?- (cl-incf minus))
1198 (?! (cl-incf bang))
1199 ((or ?\\ ?#) nil)
1200 (_ (setq space 0 plus 0 minus 0 bang 0)))
1201 (cond
1202 ((looking-at diff-hunk-header-re-unified)
1203 (let* ((old1 (match-string 2))
1204 (old2 (match-string 4))
1205 (new1 (number-to-string (+ space minus)))
1206 (new2 (number-to-string (+ space plus))))
1207 (if old2
1208 (unless (string= new2 old2) (replace-match new2 t t nil 4))
1209 (goto-char (match-end 3))
1210 (insert "," new2))
1211 (if old1
1212 (unless (string= new1 old1) (replace-match new1 t t nil 2))
1213 (goto-char (match-end 1))
1214 (insert "," new1))))
1215 ((looking-at diff-context-mid-hunk-header-re)
1216 (when (> (+ space bang plus) 0)
1217 (let* ((old1 (match-string 1))
1218 (old2 (match-string 2))
1219 (new (number-to-string
1220 (+ space bang plus -1 (string-to-number old1)))))
1221 (unless (string= new old2) (replace-match new t t nil 2)))))
1222 ((looking-at "\\*\\*\\* \\([0-9]+\\),\\(-?[0-9]*\\) \\*\\*\\*\\*$")
1223 (when (> (+ space bang minus) 0)
1224 (let* ((old (match-string 1))
1225 (new (format
1226 (concat "%0" (number-to-string (length old)) "d")
1227 (+ space bang minus -1 (string-to-number old)))))
1228 (unless (string= new old) (replace-match new t t nil 2))))))
1229 (setq space 0 plus 0 minus 0 bang 0)))))))
1230
1231 ;;;;
1232 ;;;; Hooks
1233 ;;;;
1234
1235 (defun diff-write-contents-hooks ()
1236 "Fixup hunk headers if necessary."
1237 (if (buffer-modified-p) (diff-fixup-modifs (point-min) (point-max)))
1238 nil)
1239
1240 ;; It turns out that making changes in the buffer from within an
1241 ;; *-change-function is asking for trouble, whereas making them
1242 ;; from a post-command-hook doesn't pose much problems
1243 (defvar diff-unhandled-changes nil)
1244 (defun diff-after-change-function (beg end _len)
1245 "Remember to fixup the hunk header.
1246 See `after-change-functions' for the meaning of BEG, END and LEN."
1247 ;; Ignoring changes when inhibit-read-only is set is strictly speaking
1248 ;; incorrect, but it turns out that inhibit-read-only is normally not set
1249 ;; inside editing commands, while it tends to be set when the buffer gets
1250 ;; updated by an async process or by a conversion function, both of which
1251 ;; would rather not be uselessly slowed down by this hook.
1252 (when (and (not undo-in-progress) (not inhibit-read-only))
1253 (if diff-unhandled-changes
1254 (setq diff-unhandled-changes
1255 (cons (min beg (car diff-unhandled-changes))
1256 (max end (cdr diff-unhandled-changes))))
1257 (setq diff-unhandled-changes (cons beg end)))))
1258
1259 (defun diff-post-command-hook ()
1260 "Fixup hunk headers if necessary."
1261 (when (consp diff-unhandled-changes)
1262 (ignore-errors
1263 (save-excursion
1264 (goto-char (car diff-unhandled-changes))
1265 ;; Maybe we've cut the end of the hunk before point.
1266 (if (and (bolp) (not (bobp))) (backward-char 1))
1267 ;; We used to fixup modifs on all the changes, but it turns out that
1268 ;; it's safer not to do it on big changes, e.g. when yanking a big
1269 ;; diff, or when the user edits the header, since we might then
1270 ;; screw up perfectly correct values. --Stef
1271 (diff-beginning-of-hunk)
1272 (let* ((style (if (looking-at "\\*\\*\\*") 'context))
1273 (start (line-beginning-position (if (eq style 'context) 3 2)))
1274 (mid (if (eq style 'context)
1275 (save-excursion
1276 (re-search-forward diff-context-mid-hunk-header-re
1277 nil t)))))
1278 (when (and ;; Don't try to fixup changes in the hunk header.
1279 (> (car diff-unhandled-changes) start)
1280 ;; Don't try to fixup changes in the mid-hunk header either.
1281 (or (not mid)
1282 (< (cdr diff-unhandled-changes) (match-beginning 0))
1283 (> (car diff-unhandled-changes) (match-end 0)))
1284 (save-excursion
1285 (diff-end-of-hunk nil 'donttrustheader)
1286 ;; Don't try to fixup changes past the end of the hunk.
1287 (>= (point) (cdr diff-unhandled-changes))))
1288 (diff-fixup-modifs (point) (cdr diff-unhandled-changes)))))
1289 (setq diff-unhandled-changes nil))))
1290
1291 (defun diff-next-error (arg reset)
1292 ;; Select a window that displays the current buffer so that point
1293 ;; movements are reflected in that window. Otherwise, the user might
1294 ;; never see the hunk corresponding to the source she's jumping to.
1295 (pop-to-buffer (current-buffer))
1296 (if reset (goto-char (point-min)))
1297 (diff-hunk-next arg)
1298 (diff-goto-source))
1299
1300 (defvar whitespace-style)
1301 (defvar whitespace-trailing-regexp)
1302
1303 ;;;###autoload
1304 (define-derived-mode diff-mode fundamental-mode "Diff"
1305 "Major mode for viewing/editing context diffs.
1306 Supports unified and context diffs as well as (to a lesser extent)
1307 normal diffs.
1308
1309 When the buffer is read-only, the ESC prefix is not necessary.
1310 If you edit the buffer manually, diff-mode will try to update the hunk
1311 headers for you on-the-fly.
1312
1313 You can also switch between context diff and unified diff with \\[diff-context->unified],
1314 or vice versa with \\[diff-unified->context] and you can also reverse the direction of
1315 a diff with \\[diff-reverse-direction].
1316
1317 \\{diff-mode-map}"
1318
1319 (set (make-local-variable 'font-lock-defaults) diff-font-lock-defaults)
1320 (set (make-local-variable 'outline-regexp) diff-outline-regexp)
1321 (set (make-local-variable 'imenu-generic-expression)
1322 diff-imenu-generic-expression)
1323 ;; These are not perfect. They would be better done separately for
1324 ;; context diffs and unidiffs.
1325 ;; (set (make-local-variable 'paragraph-start)
1326 ;; (concat "@@ " ; unidiff hunk
1327 ;; "\\|\\*\\*\\* " ; context diff hunk or file start
1328 ;; "\\|--- [^\t]+\t")) ; context or unidiff file
1329 ;; ; start (first or second line)
1330 ;; (set (make-local-variable 'paragraph-separate) paragraph-start)
1331 ;; (set (make-local-variable 'page-delimiter) "--- [^\t]+\t")
1332 ;; compile support
1333 (set (make-local-variable 'next-error-function) 'diff-next-error)
1334
1335 (set (make-local-variable 'beginning-of-defun-function)
1336 'diff-beginning-of-file-and-junk)
1337 (set (make-local-variable 'end-of-defun-function)
1338 'diff-end-of-file)
1339
1340 (diff-setup-whitespace)
1341
1342 (setq buffer-read-only diff-default-read-only)
1343 ;; setup change hooks
1344 (if (not diff-update-on-the-fly)
1345 (add-hook 'write-contents-functions 'diff-write-contents-hooks nil t)
1346 (make-local-variable 'diff-unhandled-changes)
1347 (add-hook 'after-change-functions 'diff-after-change-function nil t)
1348 (add-hook 'post-command-hook 'diff-post-command-hook nil t))
1349 ;; Neat trick from Dave Love to add more bindings in read-only mode:
1350 (let ((ro-bind (cons 'buffer-read-only diff-mode-shared-map)))
1351 (add-to-list 'minor-mode-overriding-map-alist ro-bind)
1352 ;; Turn off this little trick in case the buffer is put in view-mode.
1353 (add-hook 'view-mode-hook
1354 (lambda ()
1355 (setq minor-mode-overriding-map-alist
1356 (delq ro-bind minor-mode-overriding-map-alist)))
1357 nil t))
1358 ;; add-log support
1359 (set (make-local-variable 'add-log-current-defun-function)
1360 'diff-current-defun)
1361 (set (make-local-variable 'add-log-buffer-file-name-function)
1362 (lambda () (diff-find-file-name nil 'noprompt)))
1363 (unless (buffer-file-name)
1364 (hack-dir-local-variables-non-file-buffer)))
1365
1366 ;;;###autoload
1367 (define-minor-mode diff-minor-mode
1368 "Toggle Diff minor mode.
1369 With a prefix argument ARG, enable Diff minor mode if ARG is
1370 positive, and disable it otherwise. If called from Lisp, enable
1371 the mode if ARG is omitted or nil.
1372
1373 \\{diff-minor-mode-map}"
1374 :group 'diff-mode :lighter " Diff"
1375 ;; FIXME: setup font-lock
1376 ;; setup change hooks
1377 (if (not diff-update-on-the-fly)
1378 (add-hook 'write-contents-functions 'diff-write-contents-hooks nil t)
1379 (make-local-variable 'diff-unhandled-changes)
1380 (add-hook 'after-change-functions 'diff-after-change-function nil t)
1381 (add-hook 'post-command-hook 'diff-post-command-hook nil t)))
1382
1383 ;;; Handy hook functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1384
1385 (defun diff-setup-whitespace ()
1386 "Set up Whitespace mode variables for the current Diff mode buffer.
1387 This sets `whitespace-style' and `whitespace-trailing-regexp' so
1388 that Whitespace mode shows trailing whitespace problems on the
1389 modified lines of the diff."
1390 (set (make-local-variable 'whitespace-style) '(face trailing))
1391 (let ((style (save-excursion
1392 (goto-char (point-min))
1393 (when (re-search-forward diff-hunk-header-re nil t)
1394 (goto-char (match-beginning 0))
1395 (diff-hunk-style)))))
1396 (set (make-local-variable 'whitespace-trailing-regexp)
1397 (if (eq style 'context)
1398 "^[-\+!] .*?\\([\t ]+\\)$"
1399 "^[-\+!<>].*?\\([\t ]+\\)$"))))
1400
1401 (defun diff-delete-if-empty ()
1402 ;; An empty diff file means there's no more diffs to integrate, so we
1403 ;; can just remove the file altogether. Very handy for .rej files if we
1404 ;; remove hunks as we apply them.
1405 (when (and buffer-file-name
1406 (eq 0 (nth 7 (file-attributes buffer-file-name))))
1407 (delete-file buffer-file-name)))
1408
1409 (defun diff-delete-empty-files ()
1410 "Arrange for empty diff files to be removed."
1411 (add-hook 'after-save-hook 'diff-delete-if-empty nil t))
1412
1413 (defun diff-make-unified ()
1414 "Turn context diffs into unified diffs if applicable."
1415 (if (save-excursion
1416 (goto-char (point-min))
1417 (and (looking-at diff-hunk-header-re) (eq (char-after) ?*)))
1418 (let ((mod (buffer-modified-p)))
1419 (unwind-protect
1420 (diff-context->unified (point-min) (point-max))
1421 (restore-buffer-modified-p mod)))))
1422
1423 ;;;
1424 ;;; Misc operations that have proved useful at some point.
1425 ;;;
1426
1427 (defun diff-next-complex-hunk ()
1428 "Jump to the next \"complex\" hunk.
1429 \"Complex\" is approximated by \"the hunk changes the number of lines\".
1430 Only works for unified diffs."
1431 (interactive)
1432 (while
1433 (and (re-search-forward diff-hunk-header-re-unified nil t)
1434 (equal (match-string 2) (match-string 4)))))
1435
1436 (defun diff-sanity-check-context-hunk-half (lines)
1437 (let ((count lines))
1438 (while
1439 (cond
1440 ((and (memq (char-after) '(?\s ?! ?+ ?-))
1441 (memq (char-after (1+ (point))) '(?\s ?\t)))
1442 (cl-decf count) t)
1443 ((or (zerop count) (= count lines)) nil)
1444 ((memq (char-after) '(?! ?+ ?-))
1445 (if (not (and (eq (char-after (1+ (point))) ?\n)
1446 (y-or-n-p "Try to auto-fix whitespace loss damage? ")))
1447 (error "End of hunk ambiguously marked")
1448 (forward-char 1) (insert " ") (forward-line -1) t))
1449 ((< lines 0)
1450 (error "End of hunk ambiguously marked"))
1451 ((not (y-or-n-p "Try to auto-fix whitespace loss and word-wrap damage? "))
1452 (error "Abort!"))
1453 ((eolp) (insert " ") (forward-line -1) t)
1454 (t (insert " ") (delete-region (- (point) 2) (- (point) 1)) t))
1455 (forward-line))))
1456
1457 (defun diff-sanity-check-hunk ()
1458 (let (;; Every modification is protected by a y-or-n-p, so it's probably
1459 ;; OK to override a read-only setting.
1460 (inhibit-read-only t))
1461 (save-excursion
1462 (cond
1463 ((not (looking-at diff-hunk-header-re))
1464 (error "Not recognizable hunk header"))
1465
1466 ;; A context diff.
1467 ((eq (char-after) ?*)
1468 (if (not (looking-at "\\*\\{15\\}\\(?: .*\\)?\n\\*\\*\\* \\([0-9]+\\)\\(?:,\\([0-9]+\\)\\)? \\*\\*\\*\\*"))
1469 (error "Unrecognized context diff first hunk header format")
1470 (forward-line 2)
1471 (diff-sanity-check-context-hunk-half
1472 (if (match-end 2)
1473 (1+ (- (string-to-number (match-string 2))
1474 (string-to-number (match-string 1))))
1475 1))
1476 (if (not (looking-at diff-context-mid-hunk-header-re))
1477 (error "Unrecognized context diff second hunk header format")
1478 (forward-line)
1479 (diff-sanity-check-context-hunk-half
1480 (if (match-end 2)
1481 (1+ (- (string-to-number (match-string 2))
1482 (string-to-number (match-string 1))))
1483 1)))))
1484
1485 ;; A unified diff.
1486 ((eq (char-after) ?@)
1487 (if (not (looking-at diff-hunk-header-re-unified))
1488 (error "Unrecognized unified diff hunk header format")
1489 (let ((before (string-to-number (or (match-string 2) "1")))
1490 (after (string-to-number (or (match-string 4) "1"))))
1491 (forward-line)
1492 (while
1493 (pcase (char-after)
1494 (?\s (cl-decf before) (cl-decf after) t)
1495 (?-
1496 (if (and (looking-at diff-file-header-re)
1497 (zerop before) (zerop after))
1498 ;; No need to query: this is a case where two patches
1499 ;; are concatenated and only counting the lines will
1500 ;; give the right result. Let's just add an empty
1501 ;; line so that our code which doesn't count lines
1502 ;; will not get confused.
1503 (progn (save-excursion (insert "\n")) nil)
1504 (cl-decf before) t))
1505 (?+ (cl-decf after) t)
1506 (_
1507 (cond
1508 ((and diff-valid-unified-empty-line
1509 ;; Not just (eolp) so we don't infloop at eob.
1510 (eq (char-after) ?\n)
1511 (> before 0) (> after 0))
1512 (cl-decf before) (cl-decf after) t)
1513 ((and (zerop before) (zerop after)) nil)
1514 ((or (< before 0) (< after 0))
1515 (error (if (or (zerop before) (zerop after))
1516 "End of hunk ambiguously marked"
1517 "Hunk seriously messed up")))
1518 ((not (y-or-n-p (concat "Try to auto-fix " (if (eolp) "whitespace loss" "word-wrap damage") "? ")))
1519 (error "Abort!"))
1520 ((eolp) (insert " ") (forward-line -1) t)
1521 (t (insert " ")
1522 (delete-region (- (point) 2) (- (point) 1)) t))))
1523 (forward-line)))))
1524
1525 ;; A plain diff.
1526 (t
1527 ;; TODO.
1528 )))))
1529
1530 (defun diff-hunk-text (hunk destp char-offset)
1531 "Return the literal source text from HUNK as (TEXT . OFFSET).
1532 If DESTP is nil, TEXT is the source, otherwise the destination text.
1533 CHAR-OFFSET is a char-offset in HUNK, and OFFSET is the corresponding
1534 char-offset in TEXT."
1535 (with-temp-buffer
1536 (insert hunk)
1537 (goto-char (point-min))
1538 (let ((src-pos nil)
1539 (dst-pos nil)
1540 (divider-pos nil)
1541 (num-pfx-chars 2))
1542 ;; Set the following variables:
1543 ;; SRC-POS buffer pos of the source part of the hunk or nil if none
1544 ;; DST-POS buffer pos of the destination part of the hunk or nil
1545 ;; DIVIDER-POS buffer pos of any divider line separating the src & dst
1546 ;; NUM-PFX-CHARS number of line-prefix characters used by this format"
1547 (cond ((looking-at "^@@")
1548 ;; unified diff
1549 (setq num-pfx-chars 1)
1550 (forward-line 1)
1551 (setq src-pos (point) dst-pos (point)))
1552 ((looking-at "^\\*\\*")
1553 ;; context diff
1554 (forward-line 2)
1555 (setq src-pos (point))
1556 (re-search-forward diff-context-mid-hunk-header-re nil t)
1557 (forward-line 0)
1558 (setq divider-pos (point))
1559 (forward-line 1)
1560 (setq dst-pos (point)))
1561 ((looking-at "^[0-9]+a[0-9,]+$")
1562 ;; normal diff, insert
1563 (forward-line 1)
1564 (setq dst-pos (point)))
1565 ((looking-at "^[0-9,]+d[0-9]+$")
1566 ;; normal diff, delete
1567 (forward-line 1)
1568 (setq src-pos (point)))
1569 ((looking-at "^[0-9,]+c[0-9,]+$")
1570 ;; normal diff, change
1571 (forward-line 1)
1572 (setq src-pos (point))
1573 (re-search-forward "^---$" nil t)
1574 (forward-line 0)
1575 (setq divider-pos (point))
1576 (forward-line 1)
1577 (setq dst-pos (point)))
1578 (t
1579 (error "Unknown diff hunk type")))
1580
1581 (if (if destp (null dst-pos) (null src-pos))
1582 ;; Implied empty text
1583 (if char-offset '("" . 0) "")
1584
1585 ;; For context diffs, either side can be empty, (if there's only
1586 ;; added or only removed text). We should then use the other side.
1587 (cond ((equal src-pos divider-pos) (setq src-pos dst-pos))
1588 ((equal dst-pos (point-max)) (setq dst-pos src-pos)))
1589
1590 (when char-offset (goto-char (+ (point-min) char-offset)))
1591
1592 ;; Get rid of anything except the desired text.
1593 (save-excursion
1594 ;; Delete unused text region
1595 (let ((keep (if destp dst-pos src-pos)))
1596 (when (and divider-pos (> divider-pos keep))
1597 (delete-region divider-pos (point-max)))
1598 (delete-region (point-min) keep))
1599 ;; Remove line-prefix characters, and unneeded lines (unified diffs).
1600 (let ((kill-char (if destp ?- ?+)))
1601 (goto-char (point-min))
1602 (while (not (eobp))
1603 (if (eq (char-after) kill-char)
1604 (delete-region (point) (progn (forward-line 1) (point)))
1605 (delete-char num-pfx-chars)
1606 (forward-line 1)))))
1607
1608 (let ((text (buffer-substring-no-properties (point-min) (point-max))))
1609 (if char-offset (cons text (- (point) (point-min))) text))))))
1610
1611
1612 (defun diff-find-text (text)
1613 "Return the buffer position (BEG . END) of the nearest occurrence of TEXT.
1614 If TEXT isn't found, nil is returned."
1615 (let* ((orig (point))
1616 (forw (and (search-forward text nil t)
1617 (cons (match-beginning 0) (match-end 0))))
1618 (back (and (goto-char (+ orig (length text)))
1619 (search-backward text nil t)
1620 (cons (match-beginning 0) (match-end 0)))))
1621 ;; Choose the closest match.
1622 (if (and forw back)
1623 (if (> (- (car forw) orig) (- orig (car back))) back forw)
1624 (or back forw))))
1625
1626 (defun diff-find-approx-text (text)
1627 "Return the buffer position (BEG . END) of the nearest occurrence of TEXT.
1628 Whitespace differences are ignored."
1629 (let* ((orig (point))
1630 (re (concat "^[ \t\n\f]*"
1631 (mapconcat 'regexp-quote (split-string text) "[ \t\n\f]+")
1632 "[ \t\n\f]*\n"))
1633 (forw (and (re-search-forward re nil t)
1634 (cons (match-beginning 0) (match-end 0))))
1635 (back (and (goto-char (+ orig (length text)))
1636 (re-search-backward re nil t)
1637 (cons (match-beginning 0) (match-end 0)))))
1638 ;; Choose the closest match.
1639 (if (and forw back)
1640 (if (> (- (car forw) orig) (- orig (car back))) back forw)
1641 (or back forw))))
1642
1643 (defsubst diff-xor (a b) (if a (if (not b) a) b))
1644
1645 (defun diff-find-source-location (&optional other-file reverse noprompt)
1646 "Find out (BUF LINE-OFFSET POS SRC DST SWITCHED).
1647 BUF is the buffer corresponding to the source file.
1648 LINE-OFFSET is the offset between the expected and actual positions
1649 of the text of the hunk or nil if the text was not found.
1650 POS is a pair (BEG . END) indicating the position of the text in the buffer.
1651 SRC and DST are the two variants of text as returned by `diff-hunk-text'.
1652 SRC is the variant that was found in the buffer.
1653 SWITCHED is non-nil if the patch is already applied.
1654 NOPROMPT, if non-nil, means not to prompt the user."
1655 (save-excursion
1656 (let* ((other (diff-xor other-file diff-jump-to-old-file))
1657 (char-offset (- (point) (diff-beginning-of-hunk t)))
1658 ;; Check that the hunk is well-formed. Otherwise diff-mode and
1659 ;; the user may disagree on what constitutes the hunk
1660 ;; (e.g. because an empty line truncates the hunk mid-course),
1661 ;; leading to potentially nasty surprises for the user.
1662 ;;
1663 ;; Suppress check when NOPROMPT is non-nil (Bug#3033).
1664 (_ (unless noprompt (diff-sanity-check-hunk)))
1665 (hunk (buffer-substring
1666 (point) (save-excursion (diff-end-of-hunk) (point))))
1667 (old (diff-hunk-text hunk reverse char-offset))
1668 (new (diff-hunk-text hunk (not reverse) char-offset))
1669 ;; Find the location specification.
1670 (line (if (not (looking-at "\\(?:\\*\\{15\\}.*\n\\)?[-@* ]*\\([0-9,]+\\)\\([ acd+]+\\([0-9,]+\\)\\)?"))
1671 (error "Can't find the hunk header")
1672 (if other (match-string 1)
1673 (if (match-end 3) (match-string 3)
1674 (unless (re-search-forward
1675 diff-context-mid-hunk-header-re nil t)
1676 (error "Can't find the hunk separator"))
1677 (match-string 1)))))
1678 (file (or (diff-find-file-name other noprompt)
1679 (error "Can't find the file")))
1680 (buf (find-file-noselect file)))
1681 ;; Update the user preference if he so wished.
1682 (when (> (prefix-numeric-value other-file) 8)
1683 (setq diff-jump-to-old-file other))
1684 (with-current-buffer buf
1685 (goto-char (point-min)) (forward-line (1- (string-to-number line)))
1686 (let* ((orig-pos (point))
1687 (switched nil)
1688 ;; FIXME: Check for case where both OLD and NEW are found.
1689 (pos (or (diff-find-text (car old))
1690 (progn (setq switched t) (diff-find-text (car new)))
1691 (progn (setq switched nil)
1692 (condition-case nil
1693 (diff-find-approx-text (car old))
1694 (invalid-regexp nil))) ;Regex too big.
1695 (progn (setq switched t)
1696 (condition-case nil
1697 (diff-find-approx-text (car new))
1698 (invalid-regexp nil))) ;Regex too big.
1699 (progn (setq switched nil) nil))))
1700 (nconc
1701 (list buf)
1702 (if pos
1703 (list (count-lines orig-pos (car pos)) pos)
1704 (list nil (cons orig-pos (+ orig-pos (length (car old))))))
1705 (if switched (list new old t) (list old new))))))))
1706
1707
1708 (defun diff-hunk-status-msg (line-offset reversed dry-run)
1709 (let ((msg (if dry-run
1710 (if reversed "already applied" "not yet applied")
1711 (if reversed "undone" "applied"))))
1712 (message (cond ((null line-offset) "Hunk text not found")
1713 ((= line-offset 0) "Hunk %s")
1714 ((= line-offset 1) "Hunk %s at offset %d line")
1715 (t "Hunk %s at offset %d lines"))
1716 msg line-offset)))
1717
1718 (defvar diff-apply-hunk-to-backup-file nil)
1719
1720 (defun diff-apply-hunk (&optional reverse)
1721 "Apply the current hunk to the source file and go to the next.
1722 By default, the new source file is patched, but if the variable
1723 `diff-jump-to-old-file' is non-nil, then the old source file is
1724 patched instead (some commands, such as `diff-goto-source' can change
1725 the value of this variable when given an appropriate prefix argument).
1726
1727 With a prefix argument, REVERSE the hunk."
1728 (interactive "P")
1729 (pcase-let ((`(,buf ,line-offset ,pos ,old ,new ,switched)
1730 ;; Sometimes we'd like to have the following behavior: if
1731 ;; REVERSE go to the new file, otherwise go to the old.
1732 ;; But that means that by default we use the old file, which is
1733 ;; the opposite of the default for diff-goto-source, and is thus
1734 ;; confusing. Also when you don't know about it it's
1735 ;; pretty surprising.
1736 ;; TODO: make it possible to ask explicitly for this behavior.
1737 ;;
1738 ;; This is duplicated in diff-test-hunk.
1739 (diff-find-source-location nil reverse)))
1740 (cond
1741 ((null line-offset)
1742 (error "Can't find the text to patch"))
1743 ((with-current-buffer buf
1744 (and buffer-file-name
1745 (backup-file-name-p buffer-file-name)
1746 (not diff-apply-hunk-to-backup-file)
1747 (not (set (make-local-variable 'diff-apply-hunk-to-backup-file)
1748 (yes-or-no-p (format "Really apply this hunk to %s? "
1749 (file-name-nondirectory
1750 buffer-file-name)))))))
1751 (error "%s"
1752 (substitute-command-keys
1753 (format "Use %s\\[diff-apply-hunk] to apply it to the other file"
1754 (if (not reverse) "\\[universal-argument] ")))))
1755 ((and switched
1756 ;; A reversed patch was detected, perhaps apply it in reverse.
1757 (not (save-window-excursion
1758 (pop-to-buffer buf)
1759 (goto-char (+ (car pos) (cdr old)))
1760 (y-or-n-p
1761 (if reverse
1762 "Hunk hasn't been applied yet; apply it now? "
1763 "Hunk has already been applied; undo it? ")))))
1764 (message "(Nothing done)"))
1765 (t
1766 ;; Apply the hunk
1767 (with-current-buffer buf
1768 (goto-char (car pos))
1769 (delete-region (car pos) (cdr pos))
1770 (insert (car new)))
1771 ;; Display BUF in a window
1772 (set-window-point (display-buffer buf) (+ (car pos) (cdr new)))
1773 (diff-hunk-status-msg line-offset (diff-xor switched reverse) nil)
1774 (when diff-advance-after-apply-hunk
1775 (diff-hunk-next))))))
1776
1777
1778 (defun diff-test-hunk (&optional reverse)
1779 "See whether it's possible to apply the current hunk.
1780 With a prefix argument, try to REVERSE the hunk."
1781 (interactive "P")
1782 (pcase-let ((`(,buf ,line-offset ,pos ,src ,_dst ,switched)
1783 (diff-find-source-location nil reverse)))
1784 (set-window-point (display-buffer buf) (+ (car pos) (cdr src)))
1785 (diff-hunk-status-msg line-offset (diff-xor reverse switched) t)))
1786
1787
1788 (defalias 'diff-mouse-goto-source 'diff-goto-source)
1789
1790 (defun diff-goto-source (&optional other-file event)
1791 "Jump to the corresponding source line.
1792 `diff-jump-to-old-file' (or its opposite if the OTHER-FILE prefix arg
1793 is given) determines whether to jump to the old or the new file.
1794 If the prefix arg is bigger than 8 (for example with \\[universal-argument] \\[universal-argument])
1795 then `diff-jump-to-old-file' is also set, for the next invocations."
1796 (interactive (list current-prefix-arg last-input-event))
1797 ;; When pointing at a removal line, we probably want to jump to
1798 ;; the old location, and else to the new (i.e. as if reverting).
1799 ;; This is a convenient detail when using smerge-diff.
1800 (if event (posn-set-point (event-end event)))
1801 (let ((rev (not (save-excursion (beginning-of-line) (looking-at "[-<]")))))
1802 (pcase-let ((`(,buf ,line-offset ,pos ,src ,_dst ,switched)
1803 (diff-find-source-location other-file rev)))
1804 (pop-to-buffer buf)
1805 (goto-char (+ (car pos) (cdr src)))
1806 (diff-hunk-status-msg line-offset (diff-xor rev switched) t))))
1807
1808
1809 (defun diff-current-defun ()
1810 "Find the name of function at point.
1811 For use in `add-log-current-defun-function'."
1812 ;; Kill change-log-default-name so it gets recomputed each time, since
1813 ;; each hunk may belong to another file which may belong to another
1814 ;; directory and hence have a different ChangeLog file.
1815 (kill-local-variable 'change-log-default-name)
1816 (save-excursion
1817 (when (looking-at diff-hunk-header-re)
1818 (forward-line 1)
1819 (re-search-forward "^[^ ]" nil t))
1820 (pcase-let ((`(,buf ,_line-offset ,pos ,src ,dst ,switched)
1821 (ignore-errors ;Signals errors in place of prompting.
1822 ;; Use `noprompt' since this is used in which-func-mode
1823 ;; and such.
1824 (diff-find-source-location nil nil 'noprompt))))
1825 (when buf
1826 (beginning-of-line)
1827 (or (when (memq (char-after) '(?< ?-))
1828 ;; Cursor is pointing at removed text. This could be a removed
1829 ;; function, in which case, going to the source buffer will
1830 ;; not help since the function is now removed. Instead,
1831 ;; try to figure out the function name just from the
1832 ;; code-fragment.
1833 (let ((old (if switched dst src)))
1834 (with-temp-buffer
1835 (insert (car old))
1836 (funcall (buffer-local-value 'major-mode buf))
1837 (goto-char (+ (point-min) (cdr old)))
1838 (add-log-current-defun))))
1839 (with-current-buffer buf
1840 (goto-char (+ (car pos) (cdr src)))
1841 (add-log-current-defun)))))))
1842
1843 (defun diff-ignore-whitespace-hunk ()
1844 "Re-diff the current hunk, ignoring whitespace differences."
1845 (interactive)
1846 (let* ((char-offset (- (point) (diff-beginning-of-hunk t)))
1847 (opts (pcase (char-after) (?@ "-bu") (?* "-bc") (_ "-b")))
1848 (line-nb (and (or (looking-at "[^0-9]+\\([0-9]+\\)")
1849 (error "Can't find line number"))
1850 (string-to-number (match-string 1))))
1851 (inhibit-read-only t)
1852 (hunk (delete-and-extract-region
1853 (point) (save-excursion (diff-end-of-hunk) (point))))
1854 (lead (make-string (1- line-nb) ?\n)) ;Line nums start at 1.
1855 (file1 (make-temp-file "diff1"))
1856 (file2 (make-temp-file "diff2"))
1857 (coding-system-for-read buffer-file-coding-system)
1858 old new)
1859 (unwind-protect
1860 (save-excursion
1861 (setq old (diff-hunk-text hunk nil char-offset))
1862 (setq new (diff-hunk-text hunk t char-offset))
1863 (write-region (concat lead (car old)) nil file1 nil 'nomessage)
1864 (write-region (concat lead (car new)) nil file2 nil 'nomessage)
1865 (with-temp-buffer
1866 (let ((status
1867 (call-process diff-command nil t nil
1868 opts file1 file2)))
1869 (pcase status
1870 (0 nil) ;Nothing to reformat.
1871 (1 (goto-char (point-min))
1872 ;; Remove the file-header.
1873 (when (re-search-forward diff-hunk-header-re nil t)
1874 (delete-region (point-min) (match-beginning 0))))
1875 (_ (goto-char (point-max))
1876 (unless (bolp) (insert "\n"))
1877 (insert hunk)))
1878 (setq hunk (buffer-string))
1879 (unless (memq status '(0 1))
1880 (error "Diff returned: %s" status)))))
1881 ;; Whatever happens, put back some equivalent text: either the new
1882 ;; one or the original one in case some error happened.
1883 (insert hunk)
1884 (delete-file file1)
1885 (delete-file file2))))
1886
1887 ;;; Fine change highlighting.
1888
1889 (defface diff-refine-change
1890 '((((class color) (min-colors 88) (background light))
1891 :background "#ffff55")
1892 (((class color) (min-colors 88) (background dark))
1893 :background "#aaaa22")
1894 (t :inverse-video t))
1895 "Face used for char-based changes shown by `diff-refine-hunk'."
1896 :group 'diff-mode)
1897
1898 (defface diff-refine-removed
1899 '((default
1900 :inherit diff-refine-change)
1901 (((class color) (min-colors 88) (background light))
1902 :background "#ffaaaa")
1903 (((class color) (min-colors 88) (background dark))
1904 :background "#aa2222"))
1905 "Face used for removed characters shown by `diff-refine-hunk'."
1906 :group 'diff-mode
1907 :version "24.3")
1908
1909 (defface diff-refine-added
1910 '((default
1911 :inherit diff-refine-change)
1912 (((class color) (min-colors 88) (background light))
1913 :background "#aaffaa")
1914 (((class color) (min-colors 88) (background dark))
1915 :background "#22aa22"))
1916 "Face used for added characters shown by `diff-refine-hunk'."
1917 :group 'diff-mode
1918 :version "24.3")
1919
1920 (defun diff-refine-preproc ()
1921 (while (re-search-forward "^[+>]" nil t)
1922 ;; Remove spurious changes due to the fact that one side of the hunk is
1923 ;; marked with leading + or > and the other with leading - or <.
1924 ;; We used to replace all the prefix chars with " " but this only worked
1925 ;; when we did char-based refinement (or when using
1926 ;; smerge-refine-weight-hack) since otherwise, the `forward' motion done
1927 ;; in chopup do not necessarily do the same as the ones in highlight
1928 ;; since the "_" is not treated the same as " ".
1929 (replace-match (cdr (assq (char-before) '((?+ . "-") (?> . "<"))))))
1930 )
1931
1932 (declare-function smerge-refine-subst "smerge-mode"
1933 (beg1 end1 beg2 end2 props-c &optional preproc props-r props-a))
1934
1935 (defun diff-refine-hunk ()
1936 "Highlight changes of hunk at point at a finer granularity."
1937 (interactive)
1938 (require 'smerge-mode)
1939 (save-excursion
1940 (diff-beginning-of-hunk t)
1941 (let* ((start (point))
1942 (style (diff-hunk-style)) ;Skips the hunk header as well.
1943 (beg (point))
1944 (props-c '((diff-mode . fine) (face diff-refine-change)))
1945 (props-r '((diff-mode . fine) (face diff-refine-removed)))
1946 (props-a '((diff-mode . fine) (face diff-refine-added)))
1947 ;; Be careful to go back to `start' so diff-end-of-hunk gets
1948 ;; to read the hunk header's line info.
1949 (end (progn (goto-char start) (diff-end-of-hunk) (point))))
1950
1951 (remove-overlays beg end 'diff-mode 'fine)
1952
1953 (goto-char beg)
1954 (pcase style
1955 (`unified
1956 (while (re-search-forward "^\\(?:-.*\n\\)+\\(\\)\\(?:\\+.*\n\\)+"
1957 end t)
1958 (smerge-refine-subst (match-beginning 0) (match-end 1)
1959 (match-end 1) (match-end 0)
1960 nil 'diff-refine-preproc props-r props-a)))
1961 (`context
1962 (let* ((middle (save-excursion (re-search-forward "^---")))
1963 (other middle))
1964 (while (re-search-forward "^\\(?:!.*\n\\)+" middle t)
1965 (smerge-refine-subst (match-beginning 0) (match-end 0)
1966 (save-excursion
1967 (goto-char other)
1968 (re-search-forward "^\\(?:!.*\n\\)+" end)
1969 (setq other (match-end 0))
1970 (match-beginning 0))
1971 other
1972 (if diff-use-changed-face props-c)
1973 'diff-refine-preproc
1974 (unless diff-use-changed-face props-r)
1975 (unless diff-use-changed-face props-a)))))
1976 (_ ;; Normal diffs.
1977 (let ((beg1 (1+ (point))))
1978 (when (re-search-forward "^---.*\n" end t)
1979 ;; It's a combined add&remove, so there's something to do.
1980 (smerge-refine-subst beg1 (match-beginning 0)
1981 (match-end 0) end
1982 nil 'diff-refine-preproc props-r props-a))))))))
1983
1984 (defun diff-undo (&optional arg)
1985 "Perform `undo', ignoring the buffer's read-only status."
1986 (interactive "P")
1987 (let ((inhibit-read-only t))
1988 (undo arg)))
1989
1990 (defun diff-add-change-log-entries-other-window ()
1991 "Iterate through the current diff and create ChangeLog entries.
1992 I.e. like `add-change-log-entry-other-window' but applied to all hunks."
1993 (interactive)
1994 ;; XXX: Currently add-change-log-entry-other-window is only called
1995 ;; once per hunk. Some hunks have multiple changes, it would be
1996 ;; good to call it for each change.
1997 (save-excursion
1998 (goto-char (point-min))
1999 (condition-case nil
2000 ;; Call add-change-log-entry-other-window for each hunk in
2001 ;; the diff buffer.
2002 (while (progn
2003 (diff-hunk-next)
2004 ;; Move to where the changes are,
2005 ;; `add-change-log-entry-other-window' works better in
2006 ;; that case.
2007 (re-search-forward
2008 (concat "\n[!+-<>]"
2009 ;; If the hunk is a context hunk with an empty first
2010 ;; half, recognize the "--- NNN,MMM ----" line
2011 "\\(-- [0-9]+\\(,[0-9]+\\)? ----\n"
2012 ;; and skip to the next non-context line.
2013 "\\( .*\n\\)*[+]\\)?")
2014 nil t))
2015 (save-excursion
2016 ;; FIXME: this pops up windows of all the buffers.
2017 (add-change-log-entry nil nil t nil t)))
2018 ;; When there's no more hunks, diff-hunk-next signals an error.
2019 (error nil))))
2020
2021 (defun diff-remove-trailing-whitespace ()
2022 "When on a buffer that contains a diff, inspects the
2023 differences and removes trailing whitespace (spaces, tabs) from
2024 the lines modified or introduced by this diff. Shows a message
2025 with the name of the altered buffers, which are unsaved. If a
2026 file referenced on the diff has no buffer and needs to be fixed,
2027 a buffer visiting that file is created."
2028 (interactive)
2029 ;; We assume that the diff header has no trailing whitespace.
2030 (let ((modified-buffers nil))
2031 (save-excursion
2032 (goto-char (point-min))
2033 (while (re-search-forward "^[+!>].*[ \t]+$" (point-max) t)
2034 (pcase-let ((`(,buf ,line-offset ,pos ,src ,_dst ,_switched)
2035 (diff-find-source-location t t)))
2036 (when line-offset
2037 (with-current-buffer buf
2038 (save-excursion
2039 (goto-char (+ (car pos) (cdr src)))
2040 (beginning-of-line)
2041 (when (re-search-forward "\\([ \t]+\\)$" (line-end-position) t)
2042 (unless (memq buf modified-buffers)
2043 (push buf modified-buffers))
2044 (replace-match ""))))))))
2045 (if modified-buffers
2046 (message "Deleted new trailing whitespace from: %s"
2047 (mapconcat (lambda (buf) (concat "`" (buffer-name buf) "'"))
2048 modified-buffers " "))
2049 (message "No trailing whitespace fixes needed."))))
2050
2051 ;; provide the package
2052 (provide 'diff-mode)
2053
2054 ;;; Old Change Log from when diff-mode wasn't part of Emacs:
2055 ;; Revision 1.11 1999/10/09 23:38:29 monnier
2056 ;; (diff-mode-load-hook): dropped.
2057 ;; (auto-mode-alist): also catch *.diffs.
2058 ;; (diff-find-file-name, diff-mode): add smarts to find the right file
2059 ;; for *.rej files (that lack any file name indication).
2060 ;;
2061 ;; Revision 1.10 1999/09/30 15:32:11 monnier
2062 ;; added support for "\ No newline at end of file".
2063 ;;
2064 ;; Revision 1.9 1999/09/15 00:01:13 monnier
2065 ;; - added basic `compile' support.
2066 ;; - have diff-kill-hunk call diff-kill-file if it's the only hunk.
2067 ;; - diff-kill-file now tries to kill the leading garbage as well.
2068 ;;
2069 ;; Revision 1.8 1999/09/13 21:10:09 monnier
2070 ;; - don't use CL in the autoloaded code
2071 ;; - accept diffs using -T
2072 ;;
2073 ;; Revision 1.7 1999/09/05 20:53:03 monnier
2074 ;; interface to ediff-patch
2075 ;;
2076 ;; Revision 1.6 1999/09/01 20:55:13 monnier
2077 ;; (ediff=patch-file): add bindings to call ediff-patch.
2078 ;; (diff-find-file-name): taken out of diff-goto-source.
2079 ;; (diff-unified->context, diff-context->unified, diff-reverse-direction,
2080 ;; diff-fixup-modifs): only use the region if a prefix arg is given.
2081 ;;
2082 ;; Revision 1.5 1999/08/31 19:18:52 monnier
2083 ;; (diff-beginning-of-file, diff-prev-file): fixed wrong parenthesis.
2084 ;;
2085 ;; Revision 1.4 1999/08/31 13:01:44 monnier
2086 ;; use `combine-after-change-calls' to minimize the slowdown of font-lock.
2087 ;;
2088
2089 ;;; diff-mode.el ends here