├── README.org
├── message-view-patch.el
└── LICENSE
/README.org:
--------------------------------------------------------------------------------
1 | #+TITLE: README
2 |
3 | [[https://melpa.org/#/message-view-patch][file:https://melpa.org/packages/message-view-patch-badge.svg]]
4 |
5 | * message-view-patch
6 |
7 | =mu4e= and =gnus= extension to colorize patch-like emails. Based on
8 | [[https://github.com/orgcandman/emacs-plugins/blob/master/gnus-article-treat-patch.el][gnus-article-treat-patch.el]] and adapted to work with =mu4e=. It also continues
9 | to work with =gnus=.
10 |
11 | This package was renamed from =mu4e-patch= to =message-view-patch= to reflect
12 | that it works with both =mu4e= and =gnus= (and maybe others?).
13 |
14 | * Installation
15 |
16 | The package =message-view-patch= may be installed directly from [[https://melpa.org/#/org-ql][MELPA]] or with other tools
17 | like [[https://github.com/raxod502/straight.el][straight.el]].
18 |
19 | After installation, add the hook,
20 |
21 | #+BEGIN_SRC emacs-lisp
22 | ;; colorize patch-based emails
23 | (add-hook 'gnus-part-display-hook 'message-view-patch-highlight)
24 | #+END_SRC
25 |
26 | * Using the old mu4e-view
27 |
28 | For users that set =mu4e-view-use-old= to non-nil, they might also want to get
29 | the =mu4e= faces, too. For that, the following code might be helpful,
30 |
31 | #+begin_src emacs-lisp
32 | (require 'mu4e)
33 | (require 'message-view-patch)
34 |
35 | (add-hook 'mu4e-view-mode-hook #'message-view-patch-highlight)
36 |
37 | (setq mu4e-view-use-old t
38 | message-view-patch-pseudo-headers
39 | '(("^Acked-by: " 'mu4e-header-key-face 'mu4e-header-value-face)
40 | ("^C\\(c\\|C\\): " 'mu4e-header-key-face 'mu4e-header-value-face)
41 | ("^From: " 'mu4e-header-key-face 'mu4e-header-value-face)
42 | ("^Link: " 'mu4e-header-key-face 'mu4e-header-value-face)
43 | ("^Reported-by: " 'mu4e-header-key-face 'mu4e-header-value-face)
44 | ("^Reviewed-by: " 'mu4e-header-key-face 'mu4e-header-value-face)
45 | ("^Signed-off-by: " 'mu4e-header-key-face 'mu4e-header-value-face)
46 | ("^Subject: " 'mu4e-header-key-face 'mu4e-header-value-face)
47 | ("^Tested-by: " 'mu4e-header-key-face 'mu4e-header-value-face)))
48 |
49 | (set-face-attribute 'message-view-patch-cite-1 nil :inherit 'mu4e-cited-1-face)
50 | (set-face-attribute 'message-view-patch-cite-2 nil :inherit 'mu4e-cited-2-face)
51 | (set-face-attribute 'message-view-patch-cite-3 nil :inherit 'mu4e-cited-3-face)
52 | (set-face-attribute 'message-view-patch-cite-4 nil :inherit 'mu4e-cited-4-face)
53 | (set-face-attribute 'message-view-patch-cite-5 nil :inherit 'mu4e-cited-5-face)
54 | (set-face-attribute 'message-view-patch-cite-6 nil :inherit 'mu4e-cited-6-face)
55 | (set-face-attribute 'message-view-patch-cite-7 nil :inherit 'mu4e-cited-7-face)
56 | #+end_src
57 |
--------------------------------------------------------------------------------
/message-view-patch.el:
--------------------------------------------------------------------------------
1 | ;;; message-view-patch.el --- Colorize patch-like emails in mu4e -*- lexical-binding: t; -*-
2 |
3 | ;; Copyright (C) 2011 Frank Terbeck.
4 | ;; Copyright (C) 2018-2021 Sean Farley.
5 |
6 | ;; Author: Sean Farley
7 | ;; URL: https://github.com/seanfarley/message-view-patch
8 | ;; Version: 0.2.0
9 | ;; Created: 2018-06-15
10 | ;; Package-Requires: ((emacs "24.4") (magit "3.0.0"))
11 | ;; Keywords: extensions mu4e gnus
12 |
13 | ;;; License
14 |
15 | ;; This program is free software: you can redistribute it and/or modify
16 | ;; it under the terms of the GNU General Public License as published by
17 | ;; the Free Software Foundation, either version 3 of the License, or
18 | ;; (at your option) any later version.
19 |
20 | ;; This program is distributed in the hope that it will be useful,
21 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 | ;; GNU General Public License for more details.
24 |
25 | ;; You should have received a copy of the GNU General Public License
26 | ;; along with this program. If not, see .
27 |
28 | ;;; Commentary:
29 |
30 | ;; This is adapted from Frank Terbeck's gnus-article-treat-patch.el but has
31 | ;; been adapted to work with mu4e.
32 |
33 | ;;; Code:
34 |
35 | (require 'diff-mode)
36 | (require 'gnus)
37 | (require 'magit)
38 |
39 | ;; Customs
40 | (defgroup message-view-patch nil
41 | "Type faces (fonts) used in message-view-patch."
42 | :group 'mu4e)
43 |
44 | (defcustom message-view-patch-regex
45 | '("^@@ -[0-9]+,[0-9]+ \\+[0-9]+,[0-9]+ @@")
46 | "List of conditions that will enable patch treatment.
47 |
48 | String values will be matched as regular expressions within the
49 | currently processed part. Non-string value are supposed to be
50 | code fragments, which determine whether or not to do treatment:
51 | The code needs to return t if treatment is wanted."
52 | :type '(repeat (string :tag "regex"))
53 | :group 'message-view-patch)
54 |
55 | ;; Faces
56 | (defgroup message-view-patch-faces nil
57 | "Type faces (fonts) used in message-view-patch."
58 | :group 'mu4e
59 | :group 'faces)
60 |
61 | (defface message-view-patch-three-dashes
62 | '((t :inherit diff-header))
63 | "Face for the three dashes in a diff header."
64 | :group 'message-view-patch-faces)
65 |
66 | (defface message-view-patch-scissors
67 | '((t :inherit diff-header))
68 | "Face for the scissors 8< lines."
69 | :group 'message-view-patch-faces)
70 |
71 | (defface message-view-patch-diff-index
72 | '((t :inherit diff-header))
73 | "Face for the diff index."
74 | :group 'message-view-patch-faces)
75 |
76 | (defface message-view-patch-diff-hunk
77 | '((t :inherit magit-diff-hunk-heading))
78 | "Face for the diff hunk."
79 | :group 'message-view-patch-faces)
80 |
81 | (defface message-view-patch-diff-equals
82 | '((t :inherit diff-header))
83 | "Face for the line of equal signs that some diffs have."
84 | :group 'message-view-patch-faces)
85 |
86 | (defface message-view-patch-commit-message
87 | '((t :inherit magit-section-highlight))
88 | "Face for the commit message."
89 | :group 'message-view-patch-faces)
90 |
91 | (defface message-view-patch-diff-stat-file
92 | '((t :inherit magit-filename))
93 | "Face for the file stats."
94 | :group 'message-view-patch-faces)
95 |
96 | (defface message-view-patch-diff-stat-bar
97 | '((t :inherit magit-section-highlight))
98 | "Face for the stat bar separator."
99 | :group 'message-view-patch-faces)
100 |
101 | (defface message-view-patch-diff-stat-num
102 | '((t :inherit magit-section-highlight))
103 | "Face for the stat number column."
104 | :group 'message-view-patch-faces)
105 |
106 | (defface message-view-patch-misc
107 | '((t :inherit magit-diff-file-heading-highlight))
108 | "Face for the \"misc line\" part of the diff."
109 | :group 'message-view-patch-faces)
110 |
111 | (defface message-view-patch-commit-comment
112 | '((t :inherit magit-section-highlight))
113 | "Face for the commit part of the diff.
114 |
115 | E.g. between two ---'s after the commit message)."
116 | :group 'message-view-patch-faces)
117 |
118 | (defface message-view-patch-diff-header
119 | '((t :inherit diff-header))
120 | "Face for the diff hunk headers."
121 | :group 'message-view-patch-faces)
122 |
123 | (defface message-view-patch-diff-added
124 | '((t :inherit diff-added))
125 | "Face for the diff lines that are added."
126 | :group 'message-view-patch-faces)
127 |
128 | (defface message-view-patch-diff-removed
129 | '((t :inherit magit-diff-removed))
130 | "Face for the diff lines that are removed."
131 | :group 'message-view-patch-faces)
132 |
133 | (defface message-view-patch-diff-context
134 | '((t :inherit magit-diff-context))
135 | "Face for the context lines in the diff."
136 | :group 'message-view-patch-faces)
137 |
138 | (defface message-view-patch-cite-1
139 | '((t :inherit gnus-cite-1))
140 | "Face for cited message parts (level 1)."
141 | :group 'message-view-patch-faces)
142 |
143 | (defface message-view-patch-cite-2
144 | '((t :inherit gnus-cite-2))
145 | "Face for cited message parts (level 2)."
146 | :group 'message-view-patch-faces)
147 |
148 | (defface message-view-patch-cite-3
149 | '((t :inherit gnus-cite-3))
150 | "Face for cited message parts (level 3)."
151 | :group 'message-view-patch-faces)
152 |
153 | (defface message-view-patch-cite-4
154 | '((t :inherit gnus-cite-4))
155 | "Face for cited message parts (level 4)."
156 | :group 'message-view-patch-faces)
157 |
158 | (defface message-view-patch-cite-5
159 | '((t :inherit gnus-cite-5))
160 | "Face for cited message parts (level 5)."
161 | :group 'message-view-patch-faces)
162 |
163 | (defface message-view-patch-cite-6
164 | '((t :inherit gnus-cite-6))
165 | "Face for cited message parts (level 6)."
166 | :group 'message-view-patch-faces)
167 |
168 | (defface message-view-patch-cite-7
169 | '((t :inherit gnus-cite-7))
170 | "Face for cited message parts (level 7)."
171 | :group 'message-view-patch-faces)
172 |
173 | ;; Pseudo-headers
174 | (defcustom message-view-patch-pseudo-headers
175 | '(("^Acked-by: " 'gnus-header-name 'gnus-header-from)
176 | ("^C\\(c\\|C\\): " 'gnus-header-name 'gnus-header-from)
177 | ("^From: " 'gnus-header-name 'gnus-header-from)
178 | ("^Link: " 'gnus-header-name 'gnus-header-from)
179 | ("^Reported-by: " 'gnus-header-name 'gnus-header-from)
180 | ("^Reviewed-by: " 'gnus-header-name 'gnus-header-from)
181 | ("^Signed-off-by: " 'gnus-header-name 'gnus-header-from)
182 | ("^Subject: " 'gnus-header-name 'gnus-header-from)
183 | ("^Suggested-by: " 'gnus-header-name 'gnus-header-from)
184 | ("^Tested-by: " 'gnus-header-name 'gnus-header-from))
185 | "List of lists of regular expressions (with two face names)
186 | which are used to determine the highlighting of pseudo headers in
187 | the commit message (such as \"Signed-off-by:\").
188 |
189 | The first face if used to highlight the header's name; the second
190 | highlights the header's value."
191 | :type '(string)
192 | :group 'message-view-patch)
193 |
194 | ;; Color handling of faces
195 | (defun message-view-patch-color-line (use-face)
196 | "Set text overlay to `USE-FACE' for the current line."
197 | (overlay-put (make-overlay (point-at-bol) (point-at-eol)) 'face use-face))
198 |
199 | (defun message-view-patch-pseduo-header-get (line)
200 | "Check if `LINE' is a pseudo header.
201 |
202 | If so return its entry in `message-view-patch-pseudo-headers'."
203 | (catch 'done
204 | (dolist (entry message-view-patch-pseudo-headers)
205 | (let ((regex (car entry)))
206 | (if (string-match regex line)
207 | (throw 'done entry))))
208 | (throw 'done '())))
209 |
210 | (defun message-view-patch-pseudo-header-p (line)
211 | "Return t if `LINE' is a pseudo-header; nil otherwise.
212 |
213 | `message-view-patch-pseudo-headers' is used to determine what a
214 | pseudo-header is."
215 | (if (eq (message-view-patch-pseduo-header-get line) '()) nil t))
216 |
217 | (defun message-view-patch-pseudo-header-color (line)
218 | "Colorize a pseudo-header `LINE'."
219 | (let ((data (message-view-patch-pseduo-header-get line)))
220 | (if (eq data '())
221 | nil
222 | (let* ((s (point-at-bol))
223 | (e (point-at-eol))
224 | (colon (re-search-forward ":"))
225 | (value (+ colon 1)))
226 | (overlay-put (make-overlay s colon) 'face (nth 1 data))
227 | (overlay-put (make-overlay value e) 'face (nth 2 data))))))
228 |
229 | ;; diff-stat
230 | (defun message-view-patch-diff-stat-color ()
231 | "Colorize a diff-stat `LINE'."
232 | (let ((s (point-at-bol))
233 | (e (point-at-eol))
234 | (bar (- (re-search-forward "|") 1))
235 | (num (- (re-search-forward "[0-9]") 1))
236 | (pm (- (re-search-forward "\\([+-]\\|$\\)") 1)))
237 |
238 | (overlay-put (make-overlay s (- bar 1)) 'face 'message-view-patch-diff-stat-file)
239 | (overlay-put (make-overlay bar (+ bar 1)) 'face 'message-view-patch-diff-stat-bar)
240 | (overlay-put (make-overlay num pm) 'face 'message-view-patch-diff-stat-num)
241 |
242 | (goto-char pm)
243 | (let* ((plus (looking-at "\\+"))
244 | (brk (if plus
245 | (re-search-forward "-" e t)
246 | (re-search-forward "\\+" e t)))
247 | (first-face (if plus 'message-view-patch-diff-added 'message-view-patch-diff-removed))
248 | (second-face (if plus 'message-view-patch-diff-removed 'message-view-patch-diff-added)))
249 |
250 | (if (null brk)
251 | (overlay-put (make-overlay pm e) 'face first-face)
252 | (progn
253 | (setq brk (- brk 1))
254 | (overlay-put (make-overlay pm brk) 'face first-face)
255 | (overlay-put (make-overlay brk e) 'face second-face))))))
256 |
257 | (defun message-view-patch-diff-stat-summary-color ()
258 | "Colorize a diff-stat summary `LINE'."
259 | (let* ((e (point-at-eol))
260 | (plus (- (re-search-forward "(\\+)" e t) 2))
261 | (minus (- (re-search-forward "(-)" e t) 2)))
262 | (overlay-put (make-overlay plus (+ plus 1)) 'face 'message-view-patch-diff-added)
263 | (overlay-put (make-overlay minus (+ minus 1)) 'face 'message-view-patch-diff-removed)))
264 |
265 | (defun message-view-patch-diff-stat-line-p (line)
266 | "Return t if `LINE' is a diff-stat line; nil otherwise."
267 | (string-match "^ *[^ ]+[^|]+| +[0-9]+\\( *\\| +[+-]+\\)$" line))
268 |
269 | (defun message-view-patch-diff-stat-summary-p (line)
270 | "Return t if `LINE' is a diff-stat summary-line; nil otherwise."
271 | (string-match "^ *[0-9]+ file\\(s\\|\\) changed,.*insertion.*deletion" line))
272 |
273 | ;; unified-diffs
274 | (defun message-view-patch-diff-header-p (line)
275 | "Return t if `LINE' is a diff-header; nil otherwise."
276 | (cond
277 | ((string-match "^\\(\\+\\+\\+\\|---\\) " line) t)
278 | ((string-match "^diff -" line) t)
279 | (t nil)))
280 |
281 | (defun message-view-patch-index-line-p (line)
282 | "Return t if `LINE' is an index-line; nil otherwise."
283 | (cond
284 | ((string-match "^Index: " line) t)
285 | ((string-match "^index [0-9a-f]+\\.\\.[0-9a-f]+" line) t)
286 | (t nil)))
287 |
288 | (defun message-view-patch-hunk-line-p (line)
289 | "Return t if `LINE' is a hunk-line; nil otherwise."
290 | (string-match "^@@ -[0-9]+,[0-9]+ \\+[0-9]+,[0-9]+ @@" line))
291 |
292 | (defun message-view-patch-atp-misc-diff-p (line)
293 | "Return t if `LINE' is a \"misc line\"; nil otherwise.
294 |
295 | This is tested with respect to patch treatment."
296 | (let ((patterns '("^new file"
297 | "^RCS file:"
298 | "^retrieving revision ")))
299 | (catch 'done
300 | (dolist (regex patterns)
301 | (if (string-match regex line)
302 | (throw 'done t)))
303 | (throw 'done nil))))
304 |
305 | (defun message-view-patch-atp-looks-like-diff (line)
306 | "Return t if `LINE' is a unified diff; nil otherwise.
307 |
308 | This will test anything that even looks remotely like a line from
309 | a unified diff"
310 | (or (message-view-patch-index-line-p line)
311 | (message-view-patch-diff-header-p line)
312 | (message-view-patch-hunk-line-p line)))
313 |
314 | ;; miscellaneous line handlers
315 | (defun message-view-patch-scissors-line-p (line)
316 | "Return t if `LINE' is a scissors-line; nil otherwise."
317 | (cond
318 | ((string-match "^\\( *--* *\\(8<\\|>8\\)\\)+ *-* *$" line) t)
319 | (t nil)))
320 |
321 | (defun message-view-patch-reply-line-p (line)
322 | "Return face if `LINE' is a reply to previous message; nil otherwise."
323 | (cond
324 | ((string-match "^> *> *> *> *> *> *>" line) 'message-view-patch-cite-7)
325 | ((string-match "^> *> *> *> *> *> " line) 'message-view-patch-cite-6)
326 | ((string-match "^> *> *> *> *> " line) 'message-view-patch-cite-5)
327 | ((string-match "^> *> *> *> " line) 'message-view-patch-cite-4)
328 | ((string-match "^> *> *> " line) 'message-view-patch-cite-3)
329 | ((string-match "^> *> " line) 'message-view-patch-cite-2)
330 | ((string-match "^> " line) 'message-view-patch-cite-1)
331 | (t nil)))
332 |
333 | ;; Patch mail detection
334 | (defun message-view-patch-want-treatment ()
335 | "Return t if patch treatment is wanted.
336 |
337 | Run through `message-view-patch-regex' to determine
338 | whether patch treatment is wanted or not."
339 | (catch 'done
340 | (save-excursion
341 | (goto-char (point-min))
342 | (dolist (entry message-view-patch-regex)
343 | (cond
344 | ((stringp entry)
345 | (if (re-search-forward entry nil t)
346 | (throw 'done t)))
347 | (t
348 | (if (eval entry)
349 | (throw 'done t)))))
350 | (throw 'done nil))))
351 |
352 | ;; The actual treatment code
353 | (defun message-view-patch-state-machine ()
354 | "Colorize a part of the mu4e-view buffer.
355 |
356 | Implement the state machine which colorizes a part of an article
357 | if it looks patch-like.
358 |
359 | The state machine works like this:
360 |
361 | 0a. The machinery starts at the first line of the article's
362 | body. Not the header lines. We don't care about header
363 | lines at all.
364 |
365 | 0b. The whole thing works line by line. It doesn't do any
366 | forward or backward looks.
367 |
368 | 1. Initially, we assume, that what we'll see first is part of
369 | the patch's commit-message. Hence this first initial state
370 | is \"commit-message\". There are several ways out of this
371 | state:
372 |
373 | a) a scissors line is found (see 2.)
374 | b) a pseudo-header line is found (see 3.)
375 | c) a three-dashes line is found (see 4.)
376 | d) something that looks like the start of a unified diff is
377 | found (see 7.)
378 |
379 | 2. A scissors line is something that looks like a pair of
380 | scissors running through a piece of paper. Like this:
381 |
382 | ------ 8< ----- 8< ------
383 |
384 | or this:
385 |
386 | ------------>8-----------
387 |
388 | The function `message-view-patch-scissors-line-p' decides whether a
389 | line is a scissors line or not. After a scissors line was
390 | treated, the machine will switch back to the
391 | \"commit-mesage\" state.
392 |
393 | 3. This is very similar to a scissors line. It'll just return
394 | to the old state after its being done. The
395 | `message-view-patch-pseudo-header-p' function decides if a line is a
396 | pseudo header. The line will be appropriately colored.
397 |
398 | 4. A three-dashes line is a line that looks like this: \"---\".
399 | It's the definite end of the \"commit-message\" state. The
400 | three dashes line is coloured and the state switches to
401 | \"commit-comment\". (See 5.)
402 |
403 | 5. Nothing in \"commit-comment\" will appear in the generated
404 | commit (this is git-am specific semantics, but it's useful,
405 | so...). It may contain things like random comments or -
406 | promimently - a diff stat. (See 6.)
407 |
408 | 6. A diff stat provides statistics about how much changed in a
409 | given commit by files and by whole commit (in a summary
410 | line). Two functions `message-view-patch-diff-stat-line-p' and
411 | `message-view-patch-diff-stat-summary-p' decide if a line belongs to
412 | a diff stat. It's coloured appropriately and the state
413 | switches back to \"commit-comment\".
414 |
415 | 7. There is a function `message-view-patch-atp-looks-like-diff' which
416 | will cause the state to switch to \"unified-diff\" state
417 | from either \"commit-message\" or \"commit-comment\". In
418 | this mode there can be a set of lines types:
419 |
420 | a) diff-header lines (`message-view-patch-diff-header-p')
421 | b) index lines (`message-view-patch-index-line-p')
422 | c) hunk lines (`message-view-patch-hunk-line-p')
423 | d) equals line (\"^==*$\")
424 | e) context lines (\"^ \")
425 | f) add lines (\"^\\+\")
426 | g) remove lines (\"^-\")
427 | h) empty lines (\"^$\")
428 |
429 | This state runs until the end of the part."
430 | (catch 'message-view-patch-atp-done
431 | (let ((state 'commit-message)
432 | line do-not-move)
433 |
434 | (while t
435 | ;; Put the current line into an easy-to-handle string variable.
436 | (setq line
437 | (buffer-substring-no-properties (point-at-bol) (point-at-eol)))
438 | (setq do-not-move nil)
439 |
440 | ;; Switched state machine. The "real" states are `commit-message',
441 | ;; `commit-comment' and `unified-diff'. The other "states" are only
442 | ;; single-line colourisations that return to their respective parent-
443 | ;; state. Each state may (throw 'message-view-patch-atp-done) to leave the state-
444 | ;; machine immediately.
445 | (setq state
446 | (cond
447 |
448 | ((eq state 'commit-message)
449 | (cond
450 | ((message-view-patch-scissors-line-p line)
451 | (message-view-patch-color-line 'message-view-patch-scissors)
452 | 'commit-message)
453 | ((message-view-patch-pseudo-header-p line)
454 | (message-view-patch-pseudo-header-color line)
455 | 'commit-message)
456 | ((string= line "---")
457 | (message-view-patch-color-line 'message-view-patch-three-dashes)
458 | 'commit-comment)
459 | ((message-view-patch-atp-looks-like-diff line)
460 | (setq do-not-move t)
461 | 'unified-diff)
462 | ((message-view-patch-reply-line-p line)
463 | (message-view-patch-color-line (message-view-patch-reply-line-p line))
464 | 'commit-message)
465 | (t
466 | (message-view-patch-color-line 'message-view-patch-commit-message)
467 | 'commit-message)))
468 |
469 | ((eq state 'commit-comment)
470 | (cond
471 | ((message-view-patch-diff-stat-line-p line)
472 | (message-view-patch-diff-stat-color)
473 | 'commit-comment)
474 | ((message-view-patch-diff-stat-summary-p line)
475 | (message-view-patch-diff-stat-summary-color)
476 | 'commit-comment)
477 | ((message-view-patch-atp-looks-like-diff line)
478 | (setq do-not-move t)
479 | 'unified-diff)
480 | ((message-view-patch-reply-line-p line)
481 | (message-view-patch-color-line (message-view-patch-reply-line-p line))
482 | 'commit-message)
483 | (t
484 | (message-view-patch-color-line 'message-view-patch-commit-comment)
485 | 'commit-comment)))
486 |
487 | ((eq state 'unified-diff)
488 | (cond
489 | ((message-view-patch-diff-header-p line)
490 | (message-view-patch-color-line 'message-view-patch-diff-header)
491 | 'unified-diff)
492 | ((message-view-patch-index-line-p line)
493 | (message-view-patch-color-line 'message-view-patch-diff-index)
494 | 'unified-diff)
495 | ((message-view-patch-hunk-line-p line)
496 | (message-view-patch-color-line 'message-view-patch-diff-hunk)
497 | 'unified-diff)
498 | ((string-match "^==*$" line)
499 | (message-view-patch-color-line 'message-view-patch-diff-equals)
500 | 'unified-diff)
501 | ((string-match "^$" line)
502 | 'unified-diff)
503 | ((string-match "^ " line)
504 | (message-view-patch-color-line 'message-view-patch-diff-context)
505 | 'unified-diff)
506 | ((message-view-patch-atp-misc-diff-p line)
507 | (message-view-patch-color-line 'message-view-patch-misc)
508 | 'unified-diff)
509 | ((string-match "^\\+" line)
510 | (message-view-patch-color-line 'message-view-patch-diff-added)
511 | 'unified-diff)
512 | ((string-match "^-- $" line) ;; rare that the entire line exactly "-- " so just treat
513 | ;; as a git-diff ending marker
514 | (message-view-patch-color-line 'message-view-patch-diff-header)
515 | 'unified-diff)
516 | ((string-match "^-" line)
517 | (message-view-patch-color-line 'message-view-patch-diff-removed)
518 | 'unified-diff)
519 | (t 'unified-diff)))))
520 |
521 | (if (not do-not-move)
522 | (if (> (forward-line) 0)
523 | (throw 'message-view-patch-atp-done t)))))))
524 |
525 | ;;;###autoload
526 | (defun message-view-patch-highlight ()
527 | "Highlight mail parts, that look like patches.
528 |
529 | Well, usually they *are* patches - or possibly, when you take
530 | git's format-patch output, entire commit exports - including
531 | comments). This treatment assumes the use of unified diffs. Here
532 | is how it works:
533 |
534 | The most fancy type of patch mails look like this:
535 |
536 | From: ...
537 | Subject: ...
538 | Other-Headers: ...
539 |
540 | Body text, which can be reflecting the commit message but may
541 | optionally be followed by a so called scissors line, which
542 | looks like this (in case of a scissors line, the text above is
543 | not part of the commit message):
544 |
545 | -------8<----------
546 |
547 | If there really was a scissors line, then it's usually
548 | followed by repeated mail-headers. Which do not *have* to
549 | be the same as the one from the sender.
550 |
551 | From: ...
552 | Subject: ...
553 |
554 | More text. Usually part of the commit message. Likely
555 | multiline. What follows may be an optional diffstat. If
556 | there is one, it's usually preceded by a line that contains
557 | only three dashes and nothing more. Before the diffstat,
558 | however, there may be a set of pseudo headers again, like
559 | these:
560 |
561 | Acked-by: Mike Dev
562 | Signed-off-by: Joe D. User
563 |
564 | ---
565 | ChangeLog | 5 ++++-
566 | 1 file changed, 4 insertions(+), 1 deletions(-)
567 |
568 | Now, there is again room for optional text, which is not
569 | part of the actual commit message. May be multiline. Actually,
570 | anything between the three-dashes line and the diff content
571 | is ignored as far as the commit message goes.
572 |
573 | Now for the actual diff part. I want this to work for as
574 | many unified diff formats as possible. What comes to mind
575 | is the format used by git and the format used by cvs and
576 | quilt.
577 |
578 | CVS style looks like this:
579 |
580 | Index: foo/bar.c
581 | ============================================================
582 | --- boo.orig/foo/bar.c 2010-02-24 ....
583 | +++ boo/foo/bar.c 2010-02-28 ....
584 | @@ -1823,7 +1823,7 @@
585 |
586 |
587 | There may be multiple hunks. Each file gets an \"Index:\" and
588 | equals line. Now the git format looks like this:
589 |
590 | diff --git a/ChangeLog b/ChangeLog
591 | index 6ffbc8c..36e5c17 100644
592 | --- a/ChangeLog
593 | +++ b/ChangeLog
594 | @@ -3,6 +3,9 @@
595 |
596 |
597 | Again, there may be multiple hunks.
598 |
599 | When all hunks and all files are done, there may be additional
600 | text below the actual text.
601 |
602 | And that's it.
603 |
604 | You may define the look of several things: pseudo headers, scissor
605 | lines, three-dashes-line, equals lines, diffstat lines, diffstat
606 | summary. Then there is added lines, removed lines, context lines,
607 | diff-header lines and diff-file-header lines, for which we are
608 | borrowing the highlighting faces for from `diff-mode'."
609 | (if (message-view-patch-want-treatment)
610 | (save-excursion
611 | (progn
612 | (let ((inhibit-read-only t))
613 | (goto-char (point-min))
614 | (message-view-patch-state-machine))))))
615 |
616 | (provide 'message-view-patch)
617 |
618 | ;;; message-view-patch.el ends here
619 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU General Public License is a free, copyleft license for
11 | software and other kinds of works.
12 |
13 | The licenses for most software and other practical works are designed
14 | to take away your freedom to share and change the works. By contrast,
15 | the GNU General Public License is intended to guarantee your freedom to
16 | share and change all versions of a program--to make sure it remains free
17 | software for all its users. We, the Free Software Foundation, use the
18 | GNU General Public License for most of our software; it applies also to
19 | any other work released this way by its authors. You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | them if you wish), that you receive source code or can get it if you
26 | want it, that you can change the software or use pieces of it in new
27 | free programs, and that you know you can do these things.
28 |
29 | To protect your rights, we need to prevent others from denying you
30 | these rights or asking you to surrender the rights. Therefore, you have
31 | certain responsibilities if you distribute copies of the software, or if
32 | you modify it: responsibilities to respect the freedom of others.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must pass on to the recipients the same
36 | freedoms that you received. You must make sure that they, too, receive
37 | or can get the source code. And you must show them these terms so they
38 | know their rights.
39 |
40 | Developers that use the GNU GPL protect your rights with two steps:
41 | (1) assert copyright on the software, and (2) offer you this License
42 | giving you legal permission to copy, distribute and/or modify it.
43 |
44 | For the developers' and authors' protection, the GPL clearly explains
45 | that there is no warranty for this free software. For both users' and
46 | authors' sake, the GPL requires that modified versions be marked as
47 | changed, so that their problems will not be attributed erroneously to
48 | authors of previous versions.
49 |
50 | Some devices are designed to deny users access to install or run
51 | modified versions of the software inside them, although the manufacturer
52 | can do so. This is fundamentally incompatible with the aim of
53 | protecting users' freedom to change the software. The systematic
54 | pattern of such abuse occurs in the area of products for individuals to
55 | use, which is precisely where it is most unacceptable. Therefore, we
56 | have designed this version of the GPL to prohibit the practice for those
57 | products. If such problems arise substantially in other domains, we
58 | stand ready to extend this provision to those domains in future versions
59 | of the GPL, as needed to protect the freedom of users.
60 |
61 | Finally, every program is threatened constantly by software patents.
62 | States should not allow patents to restrict development and use of
63 | software on general-purpose computers, but in those that do, we wish to
64 | avoid the special danger that patents applied to a free program could
65 | make it effectively proprietary. To prevent this, the GPL assures that
66 | patents cannot be used to render the program non-free.
67 |
68 | The precise terms and conditions for copying, distribution and
69 | modification follow.
70 |
71 | TERMS AND CONDITIONS
72 |
73 | 0. Definitions.
74 |
75 | "This License" refers to version 3 of the GNU General Public License.
76 |
77 | "Copyright" also means copyright-like laws that apply to other kinds of
78 | works, such as semiconductor masks.
79 |
80 | "The Program" refers to any copyrightable work licensed under this
81 | License. Each licensee is addressed as "you". "Licensees" and
82 | "recipients" may be individuals or organizations.
83 |
84 | To "modify" a work means to copy from or adapt all or part of the work
85 | in a fashion requiring copyright permission, other than the making of an
86 | exact copy. The resulting work is called a "modified version" of the
87 | earlier work or a work "based on" the earlier work.
88 |
89 | A "covered work" means either the unmodified Program or a work based
90 | on the Program.
91 |
92 | To "propagate" a work means to do anything with it that, without
93 | permission, would make you directly or secondarily liable for
94 | infringement under applicable copyright law, except executing it on a
95 | computer or modifying a private copy. Propagation includes copying,
96 | distribution (with or without modification), making available to the
97 | public, and in some countries other activities as well.
98 |
99 | To "convey" a work means any kind of propagation that enables other
100 | parties to make or receive copies. Mere interaction with a user through
101 | a computer network, with no transfer of a copy, is not conveying.
102 |
103 | An interactive user interface displays "Appropriate Legal Notices"
104 | to the extent that it includes a convenient and prominently visible
105 | feature that (1) displays an appropriate copyright notice, and (2)
106 | tells the user that there is no warranty for the work (except to the
107 | extent that warranties are provided), that licensees may convey the
108 | work under this License, and how to view a copy of this License. If
109 | the interface presents a list of user commands or options, such as a
110 | menu, a prominent item in the list meets this criterion.
111 |
112 | 1. Source Code.
113 |
114 | The "source code" for a work means the preferred form of the work
115 | for making modifications to it. "Object code" means any non-source
116 | form of a work.
117 |
118 | A "Standard Interface" means an interface that either is an official
119 | standard defined by a recognized standards body, or, in the case of
120 | interfaces specified for a particular programming language, one that
121 | is widely used among developers working in that language.
122 |
123 | The "System Libraries" of an executable work include anything, other
124 | than the work as a whole, that (a) is included in the normal form of
125 | packaging a Major Component, but which is not part of that Major
126 | Component, and (b) serves only to enable use of the work with that
127 | Major Component, or to implement a Standard Interface for which an
128 | implementation is available to the public in source code form. A
129 | "Major Component", in this context, means a major essential component
130 | (kernel, window system, and so on) of the specific operating system
131 | (if any) on which the executable work runs, or a compiler used to
132 | produce the work, or an object code interpreter used to run it.
133 |
134 | The "Corresponding Source" for a work in object code form means all
135 | the source code needed to generate, install, and (for an executable
136 | work) run the object code and to modify the work, including scripts to
137 | control those activities. However, it does not include the work's
138 | System Libraries, or general-purpose tools or generally available free
139 | programs which are used unmodified in performing those activities but
140 | which are not part of the work. For example, Corresponding Source
141 | includes interface definition files associated with source files for
142 | the work, and the source code for shared libraries and dynamically
143 | linked subprograms that the work is specifically designed to require,
144 | such as by intimate data communication or control flow between those
145 | subprograms and other parts of the work.
146 |
147 | The Corresponding Source need not include anything that users
148 | can regenerate automatically from other parts of the Corresponding
149 | Source.
150 |
151 | The Corresponding Source for a work in source code form is that
152 | same work.
153 |
154 | 2. Basic Permissions.
155 |
156 | All rights granted under this License are granted for the term of
157 | copyright on the Program, and are irrevocable provided the stated
158 | conditions are met. This License explicitly affirms your unlimited
159 | permission to run the unmodified Program. The output from running a
160 | covered work is covered by this License only if the output, given its
161 | content, constitutes a covered work. This License acknowledges your
162 | rights of fair use or other equivalent, as provided by copyright law.
163 |
164 | You may make, run and propagate covered works that you do not
165 | convey, without conditions so long as your license otherwise remains
166 | in force. You may convey covered works to others for the sole purpose
167 | of having them make modifications exclusively for you, or provide you
168 | with facilities for running those works, provided that you comply with
169 | the terms of this License in conveying all material for which you do
170 | not control copyright. Those thus making or running the covered works
171 | for you must do so exclusively on your behalf, under your direction
172 | and control, on terms that prohibit them from making any copies of
173 | your copyrighted material outside their relationship with you.
174 |
175 | Conveying under any other circumstances is permitted solely under
176 | the conditions stated below. Sublicensing is not allowed; section 10
177 | makes it unnecessary.
178 |
179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
180 |
181 | No covered work shall be deemed part of an effective technological
182 | measure under any applicable law fulfilling obligations under article
183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
184 | similar laws prohibiting or restricting circumvention of such
185 | measures.
186 |
187 | When you convey a covered work, you waive any legal power to forbid
188 | circumvention of technological measures to the extent such circumvention
189 | is effected by exercising rights under this License with respect to
190 | the covered work, and you disclaim any intention to limit operation or
191 | modification of the work as a means of enforcing, against the work's
192 | users, your or third parties' legal rights to forbid circumvention of
193 | technological measures.
194 |
195 | 4. Conveying Verbatim Copies.
196 |
197 | You may convey verbatim copies of the Program's source code as you
198 | receive it, in any medium, provided that you conspicuously and
199 | appropriately publish on each copy an appropriate copyright notice;
200 | keep intact all notices stating that this License and any
201 | non-permissive terms added in accord with section 7 apply to the code;
202 | keep intact all notices of the absence of any warranty; and give all
203 | recipients a copy of this License along with the Program.
204 |
205 | You may charge any price or no price for each copy that you convey,
206 | and you may offer support or warranty protection for a fee.
207 |
208 | 5. Conveying Modified Source Versions.
209 |
210 | You may convey a work based on the Program, or the modifications to
211 | produce it from the Program, in the form of source code under the
212 | terms of section 4, provided that you also meet all of these conditions:
213 |
214 | a) The work must carry prominent notices stating that you modified
215 | it, and giving a relevant date.
216 |
217 | b) The work must carry prominent notices stating that it is
218 | released under this License and any conditions added under section
219 | 7. This requirement modifies the requirement in section 4 to
220 | "keep intact all notices".
221 |
222 | c) You must license the entire work, as a whole, under this
223 | License to anyone who comes into possession of a copy. This
224 | License will therefore apply, along with any applicable section 7
225 | additional terms, to the whole of the work, and all its parts,
226 | regardless of how they are packaged. This License gives no
227 | permission to license the work in any other way, but it does not
228 | invalidate such permission if you have separately received it.
229 |
230 | d) If the work has interactive user interfaces, each must display
231 | Appropriate Legal Notices; however, if the Program has interactive
232 | interfaces that do not display Appropriate Legal Notices, your
233 | work need not make them do so.
234 |
235 | A compilation of a covered work with other separate and independent
236 | works, which are not by their nature extensions of the covered work,
237 | and which are not combined with it such as to form a larger program,
238 | in or on a volume of a storage or distribution medium, is called an
239 | "aggregate" if the compilation and its resulting copyright are not
240 | used to limit the access or legal rights of the compilation's users
241 | beyond what the individual works permit. Inclusion of a covered work
242 | in an aggregate does not cause this License to apply to the other
243 | parts of the aggregate.
244 |
245 | 6. Conveying Non-Source Forms.
246 |
247 | You may convey a covered work in object code form under the terms
248 | of sections 4 and 5, provided that you also convey the
249 | machine-readable Corresponding Source under the terms of this License,
250 | in one of these ways:
251 |
252 | a) Convey the object code in, or embodied in, a physical product
253 | (including a physical distribution medium), accompanied by the
254 | Corresponding Source fixed on a durable physical medium
255 | customarily used for software interchange.
256 |
257 | b) Convey the object code in, or embodied in, a physical product
258 | (including a physical distribution medium), accompanied by a
259 | written offer, valid for at least three years and valid for as
260 | long as you offer spare parts or customer support for that product
261 | model, to give anyone who possesses the object code either (1) a
262 | copy of the Corresponding Source for all the software in the
263 | product that is covered by this License, on a durable physical
264 | medium customarily used for software interchange, for a price no
265 | more than your reasonable cost of physically performing this
266 | conveying of source, or (2) access to copy the
267 | Corresponding Source from a network server at no charge.
268 |
269 | c) Convey individual copies of the object code with a copy of the
270 | written offer to provide the Corresponding Source. This
271 | alternative is allowed only occasionally and noncommercially, and
272 | only if you received the object code with such an offer, in accord
273 | with subsection 6b.
274 |
275 | d) Convey the object code by offering access from a designated
276 | place (gratis or for a charge), and offer equivalent access to the
277 | Corresponding Source in the same way through the same place at no
278 | further charge. You need not require recipients to copy the
279 | Corresponding Source along with the object code. If the place to
280 | copy the object code is a network server, the Corresponding Source
281 | may be on a different server (operated by you or a third party)
282 | that supports equivalent copying facilities, provided you maintain
283 | clear directions next to the object code saying where to find the
284 | Corresponding Source. Regardless of what server hosts the
285 | Corresponding Source, you remain obligated to ensure that it is
286 | available for as long as needed to satisfy these requirements.
287 |
288 | e) Convey the object code using peer-to-peer transmission, provided
289 | you inform other peers where the object code and Corresponding
290 | Source of the work are being offered to the general public at no
291 | charge under subsection 6d.
292 |
293 | A separable portion of the object code, whose source code is excluded
294 | from the Corresponding Source as a System Library, need not be
295 | included in conveying the object code work.
296 |
297 | A "User Product" is either (1) a "consumer product", which means any
298 | tangible personal property which is normally used for personal, family,
299 | or household purposes, or (2) anything designed or sold for incorporation
300 | into a dwelling. In determining whether a product is a consumer product,
301 | doubtful cases shall be resolved in favor of coverage. For a particular
302 | product received by a particular user, "normally used" refers to a
303 | typical or common use of that class of product, regardless of the status
304 | of the particular user or of the way in which the particular user
305 | actually uses, or expects or is expected to use, the product. A product
306 | is a consumer product regardless of whether the product has substantial
307 | commercial, industrial or non-consumer uses, unless such uses represent
308 | the only significant mode of use of the product.
309 |
310 | "Installation Information" for a User Product means any methods,
311 | procedures, authorization keys, or other information required to install
312 | and execute modified versions of a covered work in that User Product from
313 | a modified version of its Corresponding Source. The information must
314 | suffice to ensure that the continued functioning of the modified object
315 | code is in no case prevented or interfered with solely because
316 | modification has been made.
317 |
318 | If you convey an object code work under this section in, or with, or
319 | specifically for use in, a User Product, and the conveying occurs as
320 | part of a transaction in which the right of possession and use of the
321 | User Product is transferred to the recipient in perpetuity or for a
322 | fixed term (regardless of how the transaction is characterized), the
323 | Corresponding Source conveyed under this section must be accompanied
324 | by the Installation Information. But this requirement does not apply
325 | if neither you nor any third party retains the ability to install
326 | modified object code on the User Product (for example, the work has
327 | been installed in ROM).
328 |
329 | The requirement to provide Installation Information does not include a
330 | requirement to continue to provide support service, warranty, or updates
331 | for a work that has been modified or installed by the recipient, or for
332 | the User Product in which it has been modified or installed. Access to a
333 | network may be denied when the modification itself materially and
334 | adversely affects the operation of the network or violates the rules and
335 | protocols for communication across the network.
336 |
337 | Corresponding Source conveyed, and Installation Information provided,
338 | in accord with this section must be in a format that is publicly
339 | documented (and with an implementation available to the public in
340 | source code form), and must require no special password or key for
341 | unpacking, reading or copying.
342 |
343 | 7. Additional Terms.
344 |
345 | "Additional permissions" are terms that supplement the terms of this
346 | License by making exceptions from one or more of its conditions.
347 | Additional permissions that are applicable to the entire Program shall
348 | be treated as though they were included in this License, to the extent
349 | that they are valid under applicable law. If additional permissions
350 | apply only to part of the Program, that part may be used separately
351 | under those permissions, but the entire Program remains governed by
352 | this License without regard to the additional permissions.
353 |
354 | When you convey a copy of a covered work, you may at your option
355 | remove any additional permissions from that copy, or from any part of
356 | it. (Additional permissions may be written to require their own
357 | removal in certain cases when you modify the work.) You may place
358 | additional permissions on material, added by you to a covered work,
359 | for which you have or can give appropriate copyright permission.
360 |
361 | Notwithstanding any other provision of this License, for material you
362 | add to a covered work, you may (if authorized by the copyright holders of
363 | that material) supplement the terms of this License with terms:
364 |
365 | a) Disclaiming warranty or limiting liability differently from the
366 | terms of sections 15 and 16 of this License; or
367 |
368 | b) Requiring preservation of specified reasonable legal notices or
369 | author attributions in that material or in the Appropriate Legal
370 | Notices displayed by works containing it; or
371 |
372 | c) Prohibiting misrepresentation of the origin of that material, or
373 | requiring that modified versions of such material be marked in
374 | reasonable ways as different from the original version; or
375 |
376 | d) Limiting the use for publicity purposes of names of licensors or
377 | authors of the material; or
378 |
379 | e) Declining to grant rights under trademark law for use of some
380 | trade names, trademarks, or service marks; or
381 |
382 | f) Requiring indemnification of licensors and authors of that
383 | material by anyone who conveys the material (or modified versions of
384 | it) with contractual assumptions of liability to the recipient, for
385 | any liability that these contractual assumptions directly impose on
386 | those licensors and authors.
387 |
388 | All other non-permissive additional terms are considered "further
389 | restrictions" within the meaning of section 10. If the Program as you
390 | received it, or any part of it, contains a notice stating that it is
391 | governed by this License along with a term that is a further
392 | restriction, you may remove that term. If a license document contains
393 | a further restriction but permits relicensing or conveying under this
394 | License, you may add to a covered work material governed by the terms
395 | of that license document, provided that the further restriction does
396 | not survive such relicensing or conveying.
397 |
398 | If you add terms to a covered work in accord with this section, you
399 | must place, in the relevant source files, a statement of the
400 | additional terms that apply to those files, or a notice indicating
401 | where to find the applicable terms.
402 |
403 | Additional terms, permissive or non-permissive, may be stated in the
404 | form of a separately written license, or stated as exceptions;
405 | the above requirements apply either way.
406 |
407 | 8. Termination.
408 |
409 | You may not propagate or modify a covered work except as expressly
410 | provided under this License. Any attempt otherwise to propagate or
411 | modify it is void, and will automatically terminate your rights under
412 | this License (including any patent licenses granted under the third
413 | paragraph of section 11).
414 |
415 | However, if you cease all violation of this License, then your
416 | license from a particular copyright holder is reinstated (a)
417 | provisionally, unless and until the copyright holder explicitly and
418 | finally terminates your license, and (b) permanently, if the copyright
419 | holder fails to notify you of the violation by some reasonable means
420 | prior to 60 days after the cessation.
421 |
422 | Moreover, your license from a particular copyright holder is
423 | reinstated permanently if the copyright holder notifies you of the
424 | violation by some reasonable means, this is the first time you have
425 | received notice of violation of this License (for any work) from that
426 | copyright holder, and you cure the violation prior to 30 days after
427 | your receipt of the notice.
428 |
429 | Termination of your rights under this section does not terminate the
430 | licenses of parties who have received copies or rights from you under
431 | this License. If your rights have been terminated and not permanently
432 | reinstated, you do not qualify to receive new licenses for the same
433 | material under section 10.
434 |
435 | 9. Acceptance Not Required for Having Copies.
436 |
437 | You are not required to accept this License in order to receive or
438 | run a copy of the Program. Ancillary propagation of a covered work
439 | occurring solely as a consequence of using peer-to-peer transmission
440 | to receive a copy likewise does not require acceptance. However,
441 | nothing other than this License grants you permission to propagate or
442 | modify any covered work. These actions infringe copyright if you do
443 | not accept this License. Therefore, by modifying or propagating a
444 | covered work, you indicate your acceptance of this License to do so.
445 |
446 | 10. Automatic Licensing of Downstream Recipients.
447 |
448 | Each time you convey a covered work, the recipient automatically
449 | receives a license from the original licensors, to run, modify and
450 | propagate that work, subject to this License. You are not responsible
451 | for enforcing compliance by third parties with this License.
452 |
453 | An "entity transaction" is a transaction transferring control of an
454 | organization, or substantially all assets of one, or subdividing an
455 | organization, or merging organizations. If propagation of a covered
456 | work results from an entity transaction, each party to that
457 | transaction who receives a copy of the work also receives whatever
458 | licenses to the work the party's predecessor in interest had or could
459 | give under the previous paragraph, plus a right to possession of the
460 | Corresponding Source of the work from the predecessor in interest, if
461 | the predecessor has it or can get it with reasonable efforts.
462 |
463 | You may not impose any further restrictions on the exercise of the
464 | rights granted or affirmed under this License. For example, you may
465 | not impose a license fee, royalty, or other charge for exercise of
466 | rights granted under this License, and you may not initiate litigation
467 | (including a cross-claim or counterclaim in a lawsuit) alleging that
468 | any patent claim is infringed by making, using, selling, offering for
469 | sale, or importing the Program or any portion of it.
470 |
471 | 11. Patents.
472 |
473 | A "contributor" is a copyright holder who authorizes use under this
474 | License of the Program or a work on which the Program is based. The
475 | work thus licensed is called the contributor's "contributor version".
476 |
477 | A contributor's "essential patent claims" are all patent claims
478 | owned or controlled by the contributor, whether already acquired or
479 | hereafter acquired, that would be infringed by some manner, permitted
480 | by this License, of making, using, or selling its contributor version,
481 | but do not include claims that would be infringed only as a
482 | consequence of further modification of the contributor version. For
483 | purposes of this definition, "control" includes the right to grant
484 | patent sublicenses in a manner consistent with the requirements of
485 | this License.
486 |
487 | Each contributor grants you a non-exclusive, worldwide, royalty-free
488 | patent license under the contributor's essential patent claims, to
489 | make, use, sell, offer for sale, import and otherwise run, modify and
490 | propagate the contents of its contributor version.
491 |
492 | In the following three paragraphs, a "patent license" is any express
493 | agreement or commitment, however denominated, not to enforce a patent
494 | (such as an express permission to practice a patent or covenant not to
495 | sue for patent infringement). To "grant" such a patent license to a
496 | party means to make such an agreement or commitment not to enforce a
497 | patent against the party.
498 |
499 | If you convey a covered work, knowingly relying on a patent license,
500 | and the Corresponding Source of the work is not available for anyone
501 | to copy, free of charge and under the terms of this License, through a
502 | publicly available network server or other readily accessible means,
503 | then you must either (1) cause the Corresponding Source to be so
504 | available, or (2) arrange to deprive yourself of the benefit of the
505 | patent license for this particular work, or (3) arrange, in a manner
506 | consistent with the requirements of this License, to extend the patent
507 | license to downstream recipients. "Knowingly relying" means you have
508 | actual knowledge that, but for the patent license, your conveying the
509 | covered work in a country, or your recipient's use of the covered work
510 | in a country, would infringe one or more identifiable patents in that
511 | country that you have reason to believe are valid.
512 |
513 | If, pursuant to or in connection with a single transaction or
514 | arrangement, you convey, or propagate by procuring conveyance of, a
515 | covered work, and grant a patent license to some of the parties
516 | receiving the covered work authorizing them to use, propagate, modify
517 | or convey a specific copy of the covered work, then the patent license
518 | you grant is automatically extended to all recipients of the covered
519 | work and works based on it.
520 |
521 | A patent license is "discriminatory" if it does not include within
522 | the scope of its coverage, prohibits the exercise of, or is
523 | conditioned on the non-exercise of one or more of the rights that are
524 | specifically granted under this License. You may not convey a covered
525 | work if you are a party to an arrangement with a third party that is
526 | in the business of distributing software, under which you make payment
527 | to the third party based on the extent of your activity of conveying
528 | the work, and under which the third party grants, to any of the
529 | parties who would receive the covered work from you, a discriminatory
530 | patent license (a) in connection with copies of the covered work
531 | conveyed by you (or copies made from those copies), or (b) primarily
532 | for and in connection with specific products or compilations that
533 | contain the covered work, unless you entered into that arrangement,
534 | or that patent license was granted, prior to 28 March 2007.
535 |
536 | Nothing in this License shall be construed as excluding or limiting
537 | any implied license or other defenses to infringement that may
538 | otherwise be available to you under applicable patent law.
539 |
540 | 12. No Surrender of Others' Freedom.
541 |
542 | If conditions are imposed on you (whether by court order, agreement or
543 | otherwise) that contradict the conditions of this License, they do not
544 | excuse you from the conditions of this License. If you cannot convey a
545 | covered work so as to satisfy simultaneously your obligations under this
546 | License and any other pertinent obligations, then as a consequence you may
547 | not convey it at all. For example, if you agree to terms that obligate you
548 | to collect a royalty for further conveying from those to whom you convey
549 | the Program, the only way you could satisfy both those terms and this
550 | License would be to refrain entirely from conveying the Program.
551 |
552 | 13. Use with the GNU Affero General Public License.
553 |
554 | Notwithstanding any other provision of this License, you have
555 | permission to link or combine any covered work with a work licensed
556 | under version 3 of the GNU Affero General Public License into a single
557 | combined work, and to convey the resulting work. The terms of this
558 | License will continue to apply to the part which is the covered work,
559 | but the special requirements of the GNU Affero General Public License,
560 | section 13, concerning interaction through a network will apply to the
561 | combination as such.
562 |
563 | 14. Revised Versions of this License.
564 |
565 | The Free Software Foundation may publish revised and/or new versions of
566 | the GNU General Public License from time to time. Such new versions will
567 | be similar in spirit to the present version, but may differ in detail to
568 | address new problems or concerns.
569 |
570 | Each version is given a distinguishing version number. If the
571 | Program specifies that a certain numbered version of the GNU General
572 | Public License "or any later version" applies to it, you have the
573 | option of following the terms and conditions either of that numbered
574 | version or of any later version published by the Free Software
575 | Foundation. If the Program does not specify a version number of the
576 | GNU General Public License, you may choose any version ever published
577 | by the Free Software Foundation.
578 |
579 | If the Program specifies that a proxy can decide which future
580 | versions of the GNU General Public License can be used, that proxy's
581 | public statement of acceptance of a version permanently authorizes you
582 | to choose that version for the Program.
583 |
584 | Later license versions may give you additional or different
585 | permissions. However, no additional obligations are imposed on any
586 | author or copyright holder as a result of your choosing to follow a
587 | later version.
588 |
589 | 15. Disclaimer of Warranty.
590 |
591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
599 |
600 | 16. Limitation of Liability.
601 |
602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
610 | SUCH DAMAGES.
611 |
612 | 17. Interpretation of Sections 15 and 16.
613 |
614 | If the disclaimer of warranty and limitation of liability provided
615 | above cannot be given local legal effect according to their terms,
616 | reviewing courts shall apply local law that most closely approximates
617 | an absolute waiver of all civil liability in connection with the
618 | Program, unless a warranty or assumption of liability accompanies a
619 | copy of the Program in return for a fee.
620 |
621 | END OF TERMS AND CONDITIONS
622 |
623 | How to Apply These Terms to Your New Programs
624 |
625 | If you develop a new program, and you want it to be of the greatest
626 | possible use to the public, the best way to achieve this is to make it
627 | free software which everyone can redistribute and change under these terms.
628 |
629 | To do so, attach the following notices to the program. It is safest
630 | to attach them to the start of each source file to most effectively
631 | state the exclusion of warranty; and each file should have at least
632 | the "copyright" line and a pointer to where the full notice is found.
633 |
634 | {one line to give the program's name and a brief idea of what it does.}
635 | Copyright (C) {year} {name of author}
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see .
649 |
650 | Also add information on how to contact you by electronic and paper mail.
651 |
652 | If the program does terminal interaction, make it output a short
653 | notice like this when it starts in an interactive mode:
654 |
655 | {project} Copyright (C) {year} {fullname}
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
668 |
669 | The GNU General Public License does not permit incorporating your program
670 | into proprietary programs. If your program is a subroutine library, you
671 | may consider it more useful to permit linking proprietary applications with
672 | the library. If this is what you want to do, use the GNU Lesser General
673 | Public License instead of this License. But first, please read
674 | .
675 |
--------------------------------------------------------------------------------