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