summaryrefslogtreecommitdiff
path: root/lisp/km-diff.el
blob: a4b855b05bb81aa94f2028ee1d336bf51ecc04d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
;;; km-diff.el --- Diff-related extensions  -*- lexical-binding: t; -*-

;; Copyright (C) 2012-2020 Kyle Meyer <kyle@kyleam.com>

;; Author: Kyle Meyer <kyle@kyleam.com>
;; URL: https://git.kyleam.com/emacs.d

;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Code:

(require 'diff)
(require 'ediff)

;;;###autoload
(defun km/diff-lock-buffer ()
  "Rename current diff buffer to include new file name."
  (interactive)
  (rename-buffer
   (format "*Diff: %s*"
           (abbreviate-file-name
            (substring-no-properties (diff-find-file-name))))))

;;;###autoload
(defun km/diff-current-buffer-with-file ()
  "Like `diff-buffer-with-file', but use current buffer without prompting."
  (interactive)
  (unless (buffer-file-name)
    (user-error "Buffer isn't associated with a file"))
  (diff-buffer-with-file (current-buffer)))

(defun km/diff--with-other-window (diff-func)
  (let ((windows (window-list)))
       (unless (= (length windows) 2)
         (user-error "Function restricted to two-window frames"))
       (if-let ((file-a (buffer-file-name
                         (window-buffer (car windows))))
                (file-b (buffer-file-name
                         (window-buffer (cadr windows)))))
           (funcall diff-func file-a file-b)
         (user-error "At least one buffer is not visiting a file"))))

;;;###autoload
(defun km/diff-with-other-window ()
  "Run `diff' on current window's file and other window's file."
  (interactive)
  (km/diff--with-other-window #'diff))

;;;###autoload
(defun km/ediff-with-other-window ()
  "Run `ediff' on current window's file and other window's file."
  (interactive)
  (km/diff--with-other-window #'ediff))

(defvar km/ediff-previous-window-config nil)

;;;###autoload
(defun km/ediff-save-window-config ()
  (setq km/ediff-previous-window-config (current-window-configuration)))

;;;###autoload
(defun km/ediff-restore-window-config ()
  (when km/ediff-previous-window-config
    (set-window-configuration km/ediff-previous-window-config)
    (setq km/ediff-previous-window-config nil)))

;;; Diff review

(defvar km/diff-review-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map (kbd "C-w") #'km/diff-review-copy-comment)
    (define-key map (kbd "C-c C-n") #'km/diff-review-next-comment)
    (define-key map (kbd "C-c C-p") #'km/diff-review-previous-comment)
    (define-key map (kbd "M-o") #'km/diff-review-open-line)
    map)
  "Keymap for Diff Review mode.")

(defvar km/diff-review-font-lock-keywords
  '(("^:.*$" . 'font-lock-function-name-face)))

;;;###autoload
(define-minor-mode km/diff-review-mode
  "Minor mode for reviewing diffs.

When this mode is turned on

  * `auto-fill-mode' is enabled

  * the buffer is editable

  * \":\" is set as the comment character

\\{km/diff-review-mode-map}"
  nil
  " DiffRev"
  km/diff-review-mode-map
  (if km/diff-review-mode
      (progn
        (auto-fill-mode)
        (set (make-local-variable 'comment-start) ": ")
        (setq fill-column (+ 2 fill-column))
        (font-lock-add-keywords nil km/diff-review-font-lock-keywords)
        (setq buffer-read-only nil)
        (if (not diff-update-on-the-fly)
            (remove-hook 'write-contents-functions 'diff-write-contents-hooks t)
          (remove-hook 'after-change-functions 'diff-after-change-function t)
          (remove-hook 'post-command-hook 'diff-post-command-hook t)))
    (font-lock-remove-keywords nil km/diff-review-font-lock-keywords)
    (diff-mode))
  (when font-lock-mode
    (font-lock-flush)))

(defun km/diff-review--comment-bounds ()
  (and (eq ?: (char-after (point-at-bol)))
       (cons
        (save-excursion (goto-char (point-at-bol))
                        (if (bobp)
                            (point)
                          (while (and (eq ?: (char-after))
                                      (not (bobp)))
                            (forward-line -1))
                          (forward-line)
                          (point)))
        (save-excursion (goto-char (point-at-bol))
                        (while (and (eq ?: (char-after))
                                    (not (eobp)))
                          (forward-line 1))
                        (forward-line -1)
                        (point-at-eol)))))

(defun km/diff-review-copy-comment ()
  "Copy the comment at point, stripping the leading ': '.
When there is no comment at point or when the region is active,
fall back to `kill-region'."
  (interactive)
  (let (bounds)
    (if (or (use-region-p)
            (not (setq bounds (km/diff-review--comment-bounds))))
        (call-interactively #'kill-region)
      (message
       "%s"
       (kill-new
        (thread-last
            (buffer-substring-no-properties (car bounds) (cdr bounds))
          (replace-regexp-in-string "^: ?" "")
          (replace-regexp-in-string "\\`\\s-+" "")
          (replace-regexp-in-string "\\s-+\\'" "")))))))

(defun km/diff-review-as-mail ()
  "Export the current diff review buffer as a mail reply."
  (interactive)
  (let ((contents (buffer-substring-no-properties (point-min) (point-max))))
    (with-current-buffer (get-buffer-create "*Diff Review Mail*")
      (erase-buffer)
      (insert contents)
      (goto-char (point-min))
      (while (not (eobp))
        (insert "> ")
        (forward-line 1))
      (goto-char (point-min))
      (while (re-search-forward "^> : ?" nil t)
        (replace-match ""))
      (message-mode)
      (set-buffer-modified-p nil)
      (pop-to-buffer (current-buffer)))))

(defun km/diff-review-next-comment (&optional n)
  "Move to the Nth next comment.
If N is negative, move backward instead."
  (interactive "p")
  (when (/= n 0)
    (pcase-let ((`(,search-fn ,bound-fn ,incr-func)
                 (if (< n 0)
                     (list #'re-search-backward #'car #'1+)
                   (list #'re-search-forward #'cdr #'1-))))
      (letrec ((move
                (lambda (n)
                  (let ((bounds (km/diff-review--comment-bounds)))
                    (cond ((and (= n 0) bounds)
                           (goto-char (car bounds)))
                          ((/= n 0)
                           (when bounds
                             (goto-char (funcall bound-fn bounds)))
                           (and (funcall search-fn "^:" nil t)
                                (funcall move
                                         (funcall incr-func n))))
                          (t
                           (error "Error in movement logic")))))))
        (funcall move n)))))

(defun km/diff-review-previous-comment (&optional n)
  "Move to the Nth previous comment.
If N is negative, move to forward instead."
  (interactive "p")
  (km/diff-review-next-comment (- n)))

(defun km/diff-review-open-line ()
  "Insert a comment line above point.
If point is currently on a comment block, insert a single line.
Otherwise, insert a block of three comment lines and position
point at the middle line."
  (interactive)
  (goto-char (point-at-bol))
  (if (eq ?: (char-after))
      (progn (insert ": \n")
             (backward-char))
    (insert ": \n: \n: \n")
    (backward-char 4)))

(provide 'km-diff)
;;; km-diff.el ends here