Commit | Line | Data |
---|---|---|
23f87bed | 1 | ;;; gnus-cite.el --- parse citations in articles for Gnus |
eec82323 | 2 | |
e84b4b86 | 3 | ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, |
114f9c96 | 4 | ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc. |
16409b0b GM |
5 | |
6 | ;; Author: Per Abhiddenware | |
7 | ||
8 | ;; This file is part of GNU Emacs. | |
9 | ||
5e809f55 | 10 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
eec82323 | 11 | ;; it under the terms of the GNU General Public License as published by |
5e809f55 GM |
12 | ;; the Free Software Foundation, either version 3 of the License, or |
13 | ;; (at your option) any later version. | |
eec82323 LMI |
14 | |
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
5e809f55 | 21 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
eec82323 LMI |
22 | |
23 | ;;; Commentary: | |
24 | ||
25 | ;;; Code: | |
26 | ||
5ab7173c | 27 | (eval-when-compile (require 'cl)) |
01c52d31 MB |
28 | (eval-when-compile |
29 | (when (featurep 'xemacs) | |
30 | (require 'easy-mmode))) ; for `define-minor-mode' | |
5ab7173c | 31 | |
eec82323 | 32 | (require 'gnus) |
eec82323 | 33 | (require 'gnus-range) |
23f87bed MB |
34 | (require 'gnus-art) |
35 | (require 'message) ; for message-cite-prefix-regexp | |
eec82323 LMI |
36 | |
37 | ;;; Customization: | |
38 | ||
39 | (defgroup gnus-cite nil | |
40 | "Citation." | |
41 | :prefix "gnus-cite-" | |
42 | :link '(custom-manual "(gnus)Article Highlighting") | |
43 | :group 'gnus-article) | |
44 | ||
6748645f LMI |
45 | (defcustom gnus-cited-opened-text-button-line-format "%(%{[-]%}%)\n" |
46 | "Format of opened cited text buttons." | |
47 | :group 'gnus-cite | |
48 | :type 'string) | |
49 | ||
50 | (defcustom gnus-cited-closed-text-button-line-format "%(%{[+]%}%)\n" | |
51 | "Format of closed cited text buttons." | |
eec82323 LMI |
52 | :group 'gnus-cite |
53 | :type 'string) | |
54 | ||
55 | (defcustom gnus-cited-lines-visible nil | |
16409b0b GM |
56 | "The number of lines of hidden cited text to remain visible. |
57 | Or a pair (cons) of numbers which are the number of lines at the top | |
58 | and bottom of the text, respectively, to remain visible." | |
eec82323 LMI |
59 | :group 'gnus-cite |
60 | :type '(choice (const :tag "none" nil) | |
16409b0b GM |
61 | integer |
62 | (cons :tag "Top and Bottom" integer integer))) | |
eec82323 LMI |
63 | |
64 | (defcustom gnus-cite-parse-max-size 25000 | |
65 | "Maximum article size (in bytes) where parsing citations is allowed. | |
66 | Set it to nil to parse all articles." | |
67 | :group 'gnus-cite | |
68 | :type '(choice (const :tag "all" nil) | |
69 | integer)) | |
70 | ||
eec82323 LMI |
71 | (defcustom gnus-cite-max-prefix 20 |
72 | "Maximum possible length for a citation prefix." | |
73 | :group 'gnus-cite | |
74 | :type 'integer) | |
75 | ||
76 | (defcustom gnus-supercite-regexp | |
23f87bed | 77 | (concat "^\\(" message-cite-prefix-regexp "\\)? *" |
eec82323 | 78 | ">>>>> +\"\\([^\"\n]+\\)\" +==") |
6748645f | 79 | "*Regexp matching normal Supercite attribution lines. |
eec82323 LMI |
80 | The first grouping must match prefixes added by other packages." |
81 | :group 'gnus-cite | |
82 | :type 'regexp) | |
83 | ||
84 | (defcustom gnus-supercite-secondary-regexp "^.*\"\\([^\"\n]+\\)\" +==" | |
85 | "Regexp matching mangled Supercite attribution lines. | |
86 | The first regexp group should match the Supercite attribution." | |
87 | :group 'gnus-cite | |
88 | :type 'regexp) | |
89 | ||
90 | (defcustom gnus-cite-minimum-match-count 2 | |
91 | "Minimum number of identical prefixes before we believe it's a citation." | |
92 | :group 'gnus-cite | |
93 | :type 'integer) | |
94 | ||
23f87bed MB |
95 | ;; Some Microsoft products put in a citation that extends to the |
96 | ;; remainder of the message: | |
97 | ;; | |
98 | ;; -----Original Message----- | |
99 | ;; From: ... | |
100 | ;; To: ... | |
101 | ;; Sent: ... [date, in non-RFC-2822 format] | |
102 | ;; Subject: ... | |
103 | ;; | |
104 | ;; Cited message, with no prefixes | |
105 | ;; | |
106 | ;; The four headers are always the same. But note they are prone to | |
107 | ;; folding without additional indentation. | |
108 | ;; | |
109 | ;; Others use "----- Original Message -----" instead, and properly quote | |
110 | ;; the body using "> ". This style is handled without special cases. | |
111 | ||
6748645f | 112 | (defcustom gnus-cite-attribution-prefix |
23f87bed | 113 | "In article\\|in <\\|On \\(Mon\\|Tue\\|Wed\\|Thu\\|Fri\\|Sat\\|Sun\\),\\|----- ?Original Message ?-----" |
6748645f | 114 | "*Regexp matching the beginning of an attribution line." |
eec82323 LMI |
115 | :group 'gnus-cite |
116 | :type 'regexp) | |
117 | ||
118 | (defcustom gnus-cite-attribution-suffix | |
23f87bed | 119 | "\\(\\(wrote\\|writes\\|said\\|says\\|>\\)\\(:\\|\\.\\.\\.\\)\\|----- ?Original Message ?-----\\)[ \t]*$" |
6748645f | 120 | "*Regexp matching the end of an attribution line. |
eec82323 LMI |
121 | The text matching the first grouping will be used as a button." |
122 | :group 'gnus-cite | |
123 | :type 'regexp) | |
124 | ||
23f87bed MB |
125 | (defcustom gnus-cite-unsightly-citation-regexp |
126 | "^-----Original Message-----\nFrom: \\(.+\n\\)+\n" | |
127 | "Regexp matching Microsoft-type rest-of-message citations." | |
bf247b6e | 128 | :version "22.1" |
23f87bed MB |
129 | :group 'gnus-cite |
130 | :type 'regexp) | |
131 | ||
132 | (defcustom gnus-cite-ignore-quoted-from t | |
133 | "Non-nil means don't regard lines beginning with \">From \" as cited text. | |
134 | Those lines may have been quoted by MTAs in order not to mix up with | |
135 | the envelope From line." | |
bf247b6e | 136 | :version "22.1" |
23f87bed MB |
137 | :group 'gnus-cite |
138 | :type 'boolean) | |
139 | ||
0f49874b | 140 | (defface gnus-cite-attribution '((t (:italic t))) |
d0859c9a MB |
141 | "Face used for attribution lines." |
142 | :group 'gnus-cite) | |
0f49874b MB |
143 | ;; backward-compatibility alias |
144 | (put 'gnus-cite-attribution-face 'face-alias 'gnus-cite-attribution) | |
3d493bef | 145 | (put 'gnus-cite-attribution-face 'obsolete-face "22.1") |
eec82323 | 146 | |
0f49874b | 147 | (defcustom gnus-cite-attribution-face 'gnus-cite-attribution |
eec82323 LMI |
148 | "Face used for attribution lines. |
149 | It is merged with the face for the cited text belonging to the attribution." | |
bf247b6e | 150 | :version "22.1" |
eec82323 LMI |
151 | :group 'gnus-cite |
152 | :type 'face) | |
153 | ||
0f49874b MB |
154 | (defface gnus-cite-1 '((((class color) |
155 | (background dark)) | |
156 | (:foreground "light blue")) | |
157 | (((class color) | |
158 | (background light)) | |
159 | (:foreground "MidnightBlue")) | |
160 | (t | |
161 | (:italic t))) | |
d0859c9a MB |
162 | "Citation face." |
163 | :group 'gnus-cite) | |
0f49874b MB |
164 | ;; backward-compatibility alias |
165 | (put 'gnus-cite-face-1 'face-alias 'gnus-cite-1) | |
3d493bef | 166 | (put 'gnus-cite-face-1 'obsolete-face "22.1") |
0f49874b MB |
167 | |
168 | (defface gnus-cite-2 '((((class color) | |
169 | (background dark)) | |
170 | (:foreground "light cyan")) | |
171 | (((class color) | |
172 | (background light)) | |
173 | (:foreground "firebrick")) | |
174 | (t | |
175 | (:italic t))) | |
d0859c9a MB |
176 | "Citation face." |
177 | :group 'gnus-cite) | |
0f49874b MB |
178 | ;; backward-compatibility alias |
179 | (put 'gnus-cite-face-2 'face-alias 'gnus-cite-2) | |
3d493bef | 180 | (put 'gnus-cite-face-2 'obsolete-face "22.1") |
0f49874b MB |
181 | |
182 | (defface gnus-cite-3 '((((class color) | |
183 | (background dark)) | |
184 | (:foreground "light yellow")) | |
185 | (((class color) | |
186 | (background light)) | |
187 | (:foreground "dark green")) | |
188 | (t | |
189 | (:italic t))) | |
d0859c9a MB |
190 | "Citation face." |
191 | :group 'gnus-cite) | |
0f49874b MB |
192 | ;; backward-compatibility alias |
193 | (put 'gnus-cite-face-3 'face-alias 'gnus-cite-3) | |
3d493bef | 194 | (put 'gnus-cite-face-3 'obsolete-face "22.1") |
0f49874b MB |
195 | |
196 | (defface gnus-cite-4 '((((class color) | |
197 | (background dark)) | |
198 | (:foreground "light pink")) | |
199 | (((class color) | |
200 | (background light)) | |
201 | (:foreground "OrangeRed")) | |
202 | (t | |
203 | (:italic t))) | |
d0859c9a MB |
204 | "Citation face." |
205 | :group 'gnus-cite) | |
0f49874b MB |
206 | ;; backward-compatibility alias |
207 | (put 'gnus-cite-face-4 'face-alias 'gnus-cite-4) | |
3d493bef | 208 | (put 'gnus-cite-face-4 'obsolete-face "22.1") |
0f49874b MB |
209 | |
210 | (defface gnus-cite-5 '((((class color) | |
211 | (background dark)) | |
212 | (:foreground "pale green")) | |
213 | (((class color) | |
214 | (background light)) | |
215 | (:foreground "dark khaki")) | |
216 | (t | |
217 | (:italic t))) | |
d0859c9a MB |
218 | "Citation face." |
219 | :group 'gnus-cite) | |
0f49874b MB |
220 | ;; backward-compatibility alias |
221 | (put 'gnus-cite-face-5 'face-alias 'gnus-cite-5) | |
3d493bef | 222 | (put 'gnus-cite-face-5 'obsolete-face "22.1") |
0f49874b MB |
223 | |
224 | (defface gnus-cite-6 '((((class color) | |
225 | (background dark)) | |
226 | (:foreground "beige")) | |
227 | (((class color) | |
228 | (background light)) | |
229 | (:foreground "dark violet")) | |
230 | (t | |
231 | (:italic t))) | |
d0859c9a MB |
232 | "Citation face." |
233 | :group 'gnus-cite) | |
0f49874b MB |
234 | ;; backward-compatibility alias |
235 | (put 'gnus-cite-face-6 'face-alias 'gnus-cite-6) | |
3d493bef | 236 | (put 'gnus-cite-face-6 'obsolete-face "22.1") |
0f49874b MB |
237 | |
238 | (defface gnus-cite-7 '((((class color) | |
239 | (background dark)) | |
240 | (:foreground "orange")) | |
241 | (((class color) | |
242 | (background light)) | |
243 | (:foreground "SteelBlue4")) | |
244 | (t | |
245 | (:italic t))) | |
d0859c9a MB |
246 | "Citation face." |
247 | :group 'gnus-cite) | |
0f49874b MB |
248 | ;; backward-compatibility alias |
249 | (put 'gnus-cite-face-7 'face-alias 'gnus-cite-7) | |
3d493bef | 250 | (put 'gnus-cite-face-7 'obsolete-face "22.1") |
0f49874b MB |
251 | |
252 | (defface gnus-cite-8 '((((class color) | |
253 | (background dark)) | |
254 | (:foreground "magenta")) | |
255 | (((class color) | |
256 | (background light)) | |
257 | (:foreground "magenta")) | |
258 | (t | |
259 | (:italic t))) | |
d0859c9a MB |
260 | "Citation face." |
261 | :group 'gnus-cite) | |
0f49874b MB |
262 | ;; backward-compatibility alias |
263 | (put 'gnus-cite-face-8 'face-alias 'gnus-cite-8) | |
3d493bef | 264 | (put 'gnus-cite-face-8 'obsolete-face "22.1") |
0f49874b MB |
265 | |
266 | (defface gnus-cite-9 '((((class color) | |
267 | (background dark)) | |
268 | (:foreground "violet")) | |
269 | (((class color) | |
270 | (background light)) | |
271 | (:foreground "violet")) | |
272 | (t | |
273 | (:italic t))) | |
d0859c9a MB |
274 | "Citation face." |
275 | :group 'gnus-cite) | |
0f49874b MB |
276 | ;; backward-compatibility alias |
277 | (put 'gnus-cite-face-9 'face-alias 'gnus-cite-9) | |
3d493bef | 278 | (put 'gnus-cite-face-9 'obsolete-face "22.1") |
0f49874b MB |
279 | |
280 | (defface gnus-cite-10 '((((class color) | |
281 | (background dark)) | |
01c52d31 | 282 | (:foreground "plum1")) |
0f49874b MB |
283 | (((class color) |
284 | (background light)) | |
285 | (:foreground "medium purple")) | |
286 | (t | |
287 | (:italic t))) | |
d0859c9a MB |
288 | "Citation face." |
289 | :group 'gnus-cite) | |
0f49874b MB |
290 | ;; backward-compatibility alias |
291 | (put 'gnus-cite-face-10 'face-alias 'gnus-cite-10) | |
3d493bef | 292 | (put 'gnus-cite-face-10 'obsolete-face "22.1") |
0f49874b MB |
293 | |
294 | (defface gnus-cite-11 '((((class color) | |
295 | (background dark)) | |
296 | (:foreground "turquoise")) | |
297 | (((class color) | |
298 | (background light)) | |
299 | (:foreground "turquoise")) | |
300 | (t | |
301 | (:italic t))) | |
d0859c9a MB |
302 | "Citation face." |
303 | :group 'gnus-cite) | |
0f49874b MB |
304 | ;; backward-compatibility alias |
305 | (put 'gnus-cite-face-11 'face-alias 'gnus-cite-11) | |
3d493bef | 306 | (put 'gnus-cite-face-11 'obsolete-face "22.1") |
eec82323 LMI |
307 | |
308 | (defcustom gnus-cite-face-list | |
0f49874b | 309 | '(gnus-cite-1 gnus-cite-2 gnus-cite-3 gnus-cite-4 gnus-cite-5 gnus-cite-6 |
01c52d31 | 310 | gnus-cite-7 gnus-cite-8 gnus-cite-9 gnus-cite-10 gnus-cite-11) |
6748645f | 311 | "*List of faces used for highlighting citations. |
eec82323 LMI |
312 | |
313 | When there are citations from multiple articles in the same message, | |
314 | Gnus will try to give each citation from each article its own face. | |
315 | This should make it easier to see who wrote what." | |
316 | :group 'gnus-cite | |
01c52d31 MB |
317 | :type '(repeat face) |
318 | :set (lambda (symbol value) | |
319 | (prog1 | |
320 | (custom-set-default symbol value) | |
321 | (if (boundp 'gnus-message-max-citation-depth) | |
322 | (setq gnus-message-max-citation-depth (length value))) | |
323 | (if (boundp 'gnus-message-citation-keywords) | |
324 | (setq gnus-message-citation-keywords | |
325 | `((gnus-message-search-citation-line | |
326 | ,@(let ((list nil) | |
327 | (count 1)) | |
328 | (dolist (face value (nreverse list)) | |
329 | (push (list count (list 'quote face) 'prepend t) | |
330 | list) | |
331 | (setq count (1+ count))))))))))) | |
eec82323 LMI |
332 | |
333 | (defcustom gnus-cite-hide-percentage 50 | |
334 | "Only hide excess citation if above this percentage of the body." | |
335 | :group 'gnus-cite | |
336 | :type 'number) | |
337 | ||
338 | (defcustom gnus-cite-hide-absolute 10 | |
339 | "Only hide excess citation if above this number of lines in the body." | |
340 | :group 'gnus-cite | |
341 | :type 'integer) | |
342 | ||
eb1666e2 MB |
343 | (defcustom gnus-cite-blank-line-after-header t |
344 | "If non-nil, put a blank line between the citation header and the button." | |
345 | :group 'gnus-cite | |
346 | :type 'boolean) | |
347 | ||
23f87bed MB |
348 | ;; This has to go here because its default value depends on |
349 | ;; gnus-cite-face-list. | |
0f49874b | 350 | (defcustom gnus-article-boring-faces (cons 'gnus-signature gnus-cite-face-list) |
23f87bed MB |
351 | "List of faces that are not worth reading. |
352 | If an article has more pages below the one you are looking at, but | |
353 | nothing on those pages is a word of at least three letters that is not | |
354 | in a boring face, then the pages will be skipped." | |
355 | :type '(repeat face) | |
356 | :group 'gnus-article-hiding) | |
357 | ||
eec82323 LMI |
358 | ;;; Internal Variables: |
359 | ||
360 | (defvar gnus-cite-article nil) | |
6748645f | 361 | (defvar gnus-cite-overlay-list nil) |
eec82323 LMI |
362 | |
363 | (defvar gnus-cite-prefix-alist nil) | |
364 | ;; Alist of citation prefixes. | |
365 | ;; The cdr is a list of lines with that prefix. | |
366 | ||
367 | (defvar gnus-cite-attribution-alist nil) | |
368 | ;; Alist of attribution lines. | |
369 | ;; The car is a line number. | |
370 | ;; The cdr is the prefix for the citation started by that line. | |
371 | ||
372 | (defvar gnus-cite-loose-prefix-alist nil) | |
373 | ;; Alist of citation prefixes that have no matching attribution. | |
374 | ;; The cdr is a list of lines with that prefix. | |
375 | ||
376 | (defvar gnus-cite-loose-attribution-alist nil) | |
377 | ;; Alist of attribution lines that have no matching citation. | |
378 | ;; Each member has the form (WROTE IN PREFIX TAG), where | |
379 | ;; WROTE: is the attribution line number | |
380 | ;; IN: is the line number of the previous line if part of the same attribution, | |
381 | ;; PREFIX: Is the citation prefix of the attribution line(s), and | |
382 | ;; TAG: Is a Supercite tag, if any. | |
383 | ||
6748645f | 384 | (defvar gnus-cited-opened-text-button-line-format-alist |
eec82323 LMI |
385 | `((?b (marker-position beg) ?d) |
386 | (?e (marker-position end) ?d) | |
6748645f | 387 | (?n (count-lines beg end) ?d) |
eec82323 | 388 | (?l (- end beg) ?d))) |
6748645f LMI |
389 | (defvar gnus-cited-opened-text-button-line-format-spec nil) |
390 | (defvar gnus-cited-closed-text-button-line-format-alist | |
391 | gnus-cited-opened-text-button-line-format-alist) | |
392 | (defvar gnus-cited-closed-text-button-line-format-spec nil) | |
393 | ||
eec82323 LMI |
394 | |
395 | ;;; Commands: | |
396 | ||
01c52d31 | 397 | (defun gnus-article-highlight-citation (&optional force same-buffer) |
eec82323 LMI |
398 | "Highlight cited text. |
399 | Each citation in the article will be highlighted with a different face. | |
400 | The faces are taken from `gnus-cite-face-list'. | |
401 | Attribution lines are highlighted with the same face as the | |
0f49874b | 402 | corresponding citation merged with the face `gnus-cite-attribution'. |
eec82323 LMI |
403 | |
404 | Text is considered cited if at least `gnus-cite-minimum-match-count' | |
23f87bed | 405 | lines matches `message-cite-prefix-regexp' with the same prefix. |
eec82323 LMI |
406 | |
407 | Lines matching `gnus-cite-attribution-suffix' and perhaps | |
408 | `gnus-cite-attribution-prefix' are considered attribution lines." | |
409 | (interactive (list 'force)) | |
410 | (save-excursion | |
01c52d31 MB |
411 | (unless same-buffer |
412 | (set-buffer gnus-article-buffer)) | |
eec82323 LMI |
413 | (gnus-cite-parse-maybe force) |
414 | (let ((buffer-read-only nil) | |
415 | (alist gnus-cite-prefix-alist) | |
416 | (faces gnus-cite-face-list) | |
417 | (inhibit-point-motion-hooks t) | |
418 | face entry prefix skip numbers number face-alist) | |
419 | ;; Loop through citation prefixes. | |
420 | (while alist | |
421 | (setq entry (car alist) | |
422 | alist (cdr alist) | |
423 | prefix (car entry) | |
424 | numbers (cdr entry) | |
425 | face (car faces) | |
426 | faces (or (cdr faces) gnus-cite-face-list) | |
427 | face-alist (cons (cons prefix face) face-alist)) | |
428 | (while numbers | |
429 | (setq number (car numbers) | |
430 | numbers (cdr numbers)) | |
431 | (and (not (assq number gnus-cite-attribution-alist)) | |
432 | (not (assq number gnus-cite-loose-attribution-alist)) | |
433 | (gnus-cite-add-face number prefix face)))) | |
434 | ;; Loop through attribution lines. | |
435 | (setq alist gnus-cite-attribution-alist) | |
436 | (while alist | |
437 | (setq entry (car alist) | |
438 | alist (cdr alist) | |
439 | number (car entry) | |
440 | prefix (cdr entry) | |
441 | skip (gnus-cite-find-prefix number) | |
442 | face (cdr (assoc prefix face-alist))) | |
443 | ;; Add attribution button. | |
16409b0b GM |
444 | (goto-char (point-min)) |
445 | (forward-line (1- number)) | |
eec82323 | 446 | (when (re-search-forward gnus-cite-attribution-suffix |
01c52d31 | 447 | (point-at-eol) |
eec82323 LMI |
448 | t) |
449 | (gnus-article-add-button (match-beginning 1) (match-end 1) | |
450 | 'gnus-cite-toggle prefix)) | |
451 | ;; Highlight attribution line. | |
452 | (gnus-cite-add-face number skip face) | |
453 | (gnus-cite-add-face number skip gnus-cite-attribution-face)) | |
454 | ;; Loop through attribution lines. | |
455 | (setq alist gnus-cite-loose-attribution-alist) | |
456 | (while alist | |
457 | (setq entry (car alist) | |
458 | alist (cdr alist) | |
459 | number (car entry) | |
460 | skip (gnus-cite-find-prefix number)) | |
461 | (gnus-cite-add-face number skip gnus-cite-attribution-face))))) | |
462 | ||
463 | (defun gnus-dissect-cited-text () | |
464 | "Dissect the article buffer looking for cited text." | |
465 | (save-excursion | |
466 | (set-buffer gnus-article-buffer) | |
16409b0b | 467 | (gnus-cite-parse-maybe nil t) |
eec82323 LMI |
468 | (let ((alist gnus-cite-prefix-alist) |
469 | prefix numbers number marks m) | |
470 | ;; Loop through citation prefixes. | |
471 | (while alist | |
472 | (setq numbers (pop alist) | |
473 | prefix (pop numbers)) | |
474 | (while numbers | |
475 | (setq number (pop numbers)) | |
476 | (goto-char (point-min)) | |
477 | (forward-line number) | |
478 | (push (cons (point-marker) "") marks) | |
479 | (while (and numbers | |
480 | (= (1- number) (car numbers))) | |
481 | (setq number (pop numbers))) | |
482 | (goto-char (point-min)) | |
483 | (forward-line (1- number)) | |
484 | (push (cons (point-marker) prefix) marks))) | |
485 | ;; Skip to the beginning of the body. | |
16409b0b | 486 | (article-goto-body) |
eec82323 LMI |
487 | (push (cons (point-marker) "") marks) |
488 | ;; Find the end of the body. | |
489 | (goto-char (point-max)) | |
490 | (gnus-article-search-signature) | |
491 | (push (cons (point-marker) "") marks) | |
492 | ;; Sort the marks. | |
6748645f | 493 | (setq marks (sort marks 'car-less-than-car)) |
eec82323 LMI |
494 | (let ((omarks marks)) |
495 | (setq marks nil) | |
496 | (while (cdr omarks) | |
497 | (if (= (caar omarks) (caadr omarks)) | |
498 | (progn | |
499 | (unless (equal (cdar omarks) "") | |
500 | (push (car omarks) marks)) | |
501 | (unless (equal (cdadr omarks) "") | |
502 | (push (cadr omarks) marks)) | |
503 | (unless (and (equal (cdar omarks) "") | |
504 | (equal (cdadr omarks) "") | |
505 | (not (cddr omarks))) | |
506 | (setq omarks (cdr omarks)))) | |
507 | (push (car omarks) marks)) | |
508 | (setq omarks (cdr omarks))) | |
509 | (when (car omarks) | |
510 | (push (car omarks) marks)) | |
511 | (setq marks (setq m (nreverse marks))) | |
512 | (while (cddr m) | |
513 | (if (and (equal (cdadr m) "") | |
514 | (equal (cdar m) (cdaddr m)) | |
515 | (goto-char (caadr m)) | |
516 | (forward-line 1) | |
517 | (= (point) (caaddr m))) | |
518 | (setcdr m (cdddr m)) | |
519 | (setq m (cdr m)))) | |
520 | marks)))) | |
521 | ||
522 | (defun gnus-article-fill-cited-article (&optional force width) | |
523 | "Do word wrapping in the current article. | |
524 | If WIDTH (the numerical prefix), use that text width when filling." | |
525 | (interactive (list t current-prefix-arg)) | |
526 | (save-excursion | |
527 | (set-buffer gnus-article-buffer) | |
528 | (let ((buffer-read-only nil) | |
529 | (inhibit-point-motion-hooks t) | |
530 | (marks (gnus-dissect-cited-text)) | |
531 | (adaptive-fill-mode nil) | |
532 | (filladapt-mode nil) | |
533 | (fill-column (if width (prefix-numeric-value width) fill-column))) | |
534 | (save-restriction | |
535 | (while (cdr marks) | |
eec82323 LMI |
536 | (narrow-to-region (caar marks) (caadr marks)) |
537 | (let ((adaptive-fill-regexp | |
538 | (concat "^" (regexp-quote (cdar marks)) " *")) | |
23f87bed MB |
539 | (fill-prefix |
540 | (if (string= (cdar marks) "") "" | |
541 | (concat (cdar marks) " "))) | |
542 | use-hard-newlines) | |
eec82323 LMI |
543 | (fill-region (point-min) (point-max))) |
544 | (set-marker (caar marks) nil) | |
545 | (setq marks (cdr marks))) | |
546 | (when marks | |
547 | (set-marker (caar marks) nil)) | |
548 | ;; All this information is now incorrect. | |
549 | (setq gnus-cite-prefix-alist nil | |
550 | gnus-cite-attribution-alist nil | |
551 | gnus-cite-loose-prefix-alist nil | |
a8151ef7 LMI |
552 | gnus-cite-loose-attribution-alist nil |
553 | gnus-cite-article nil))))) | |
eec82323 LMI |
554 | |
555 | (defun gnus-article-hide-citation (&optional arg force) | |
556 | "Toggle hiding of all cited text except attribution lines. | |
557 | See the documentation for `gnus-article-highlight-citation'. | |
558 | If given a negative prefix, always show; if given a positive prefix, | |
559 | always hide." | |
560 | (interactive (append (gnus-article-hidden-arg) (list 'force))) | |
6748645f LMI |
561 | (gnus-set-format 'cited-opened-text-button t) |
562 | (gnus-set-format 'cited-closed-text-button t) | |
eec82323 LMI |
563 | (save-excursion |
564 | (set-buffer gnus-article-buffer) | |
eec82323 | 565 | (let ((buffer-read-only nil) |
520aa572 | 566 | marks |
eec82323 LMI |
567 | (inhibit-point-motion-hooks t) |
568 | (props (nconc (list 'article-type 'cite) | |
569 | gnus-hidden-properties)) | |
520aa572 SZ |
570 | (point (point-min)) |
571 | found beg end start) | |
a1506d29 JB |
572 | (while (setq point |
573 | (text-property-any point (point-max) | |
520aa572 SZ |
574 | 'gnus-callback |
575 | 'gnus-article-toggle-cited-text)) | |
576 | (setq found t) | |
577 | (goto-char point) | |
578 | (gnus-article-toggle-cited-text | |
579 | (get-text-property point 'gnus-data) arg) | |
580 | (forward-line 1) | |
581 | (setq point (point))) | |
582 | (unless found | |
583 | (setq marks (gnus-dissect-cited-text)) | |
584 | (while marks | |
585 | (setq beg nil | |
586 | end nil) | |
587 | (while (and marks (string= (cdar marks) "")) | |
588 | (setq marks (cdr marks))) | |
589 | (when marks | |
590 | (setq beg (caar marks))) | |
591 | (while (and marks (not (string= (cdar marks) ""))) | |
592 | (setq marks (cdr marks))) | |
593 | (when marks | |
eec82323 | 594 | (setq end (caar marks))) |
520aa572 SZ |
595 | ;; Skip past lines we want to leave visible. |
596 | (when (and beg end gnus-cited-lines-visible) | |
597 | (goto-char beg) | |
598 | (forward-line (if (consp gnus-cited-lines-visible) | |
599 | (car gnus-cited-lines-visible) | |
600 | gnus-cited-lines-visible)) | |
601 | (if (>= (point) end) | |
602 | (setq beg nil) | |
603 | (setq beg (point-marker)) | |
604 | (when (consp gnus-cited-lines-visible) | |
605 | (goto-char end) | |
606 | (forward-line (- (cdr gnus-cited-lines-visible))) | |
607 | (if (<= (point) beg) | |
608 | (setq beg nil) | |
16409b0b | 609 | (setq end (point-marker)))))) |
520aa572 | 610 | (when (and beg end) |
23f87bed | 611 | (gnus-add-wash-type 'cite) |
520aa572 SZ |
612 | ;; We use markers for the end-points to facilitate later |
613 | ;; wrapping and mangling of text. | |
614 | (setq beg (set-marker (make-marker) beg) | |
615 | end (set-marker (make-marker) end)) | |
616 | (gnus-add-text-properties-when 'article-type nil beg end props) | |
617 | (goto-char beg) | |
eb1666e2 MB |
618 | (when (and gnus-cite-blank-line-after-header |
619 | (not (save-excursion (search-backward "\n\n" nil t)))) | |
520aa572 SZ |
620 | (insert "\n")) |
621 | (put-text-property | |
622 | (setq start (point-marker)) | |
623 | (progn | |
eec82323 LMI |
624 | (gnus-article-add-button |
625 | (point) | |
6748645f LMI |
626 | (progn (eval gnus-cited-closed-text-button-line-format-spec) |
627 | (point)) | |
628 | `gnus-article-toggle-cited-text | |
629 | (list (cons beg end) start)) | |
eec82323 | 630 | (point)) |
520aa572 SZ |
631 | 'article-type 'annotation) |
632 | (set-marker beg (point)))))))) | |
eec82323 | 633 | |
520aa572 SZ |
634 | (defun gnus-article-toggle-cited-text (args &optional arg) |
635 | "Toggle hiding the text in REGION. | |
636 | ARG can be nil or a number. Positive means hide, negative | |
637 | means show, nil means toggle." | |
6748645f | 638 | (let* ((region (car args)) |
16409b0b GM |
639 | (beg (car region)) |
640 | (end (cdr region)) | |
6748645f LMI |
641 | (start (cadr args)) |
642 | (hidden | |
520aa572 | 643 | (text-property-any beg (1- end) 'article-type 'cite)) |
6748645f LMI |
644 | (inhibit-point-motion-hooks t) |
645 | buffer-read-only) | |
520aa572 SZ |
646 | (when (or (null arg) |
647 | (zerop arg) | |
648 | (and (> arg 0) (not hidden)) | |
649 | (and (< arg 0) hidden)) | |
650 | (if hidden | |
23f87bed MB |
651 | (progn |
652 | ;; Can't remove 'cite from g-a-wash-types here because | |
653 | ;; multiple citations may be hidden -jas | |
654 | (gnus-remove-text-properties-when | |
655 | 'article-type 'cite beg end | |
656 | (cons 'article-type (cons 'cite | |
657 | gnus-hidden-properties)))) | |
658 | (gnus-add-wash-type 'cite) | |
520aa572 | 659 | (gnus-add-text-properties-when |
a1506d29 | 660 | 'article-type nil beg end |
520aa572 SZ |
661 | (cons 'article-type (cons 'cite |
662 | gnus-hidden-properties)))) | |
23f87bed MB |
663 | (let ((gnus-article-mime-handle-alist-1 gnus-article-mime-handle-alist)) |
664 | (gnus-set-mode-line 'article)) | |
520aa572 SZ |
665 | (save-excursion |
666 | (goto-char start) | |
667 | (gnus-delete-line) | |
668 | (put-text-property | |
669 | (point) | |
670 | (progn | |
671 | (gnus-article-add-button | |
672 | (point) | |
673 | (progn (eval | |
674 | (if hidden | |
675 | gnus-cited-opened-text-button-line-format-spec | |
676 | gnus-cited-closed-text-button-line-format-spec)) | |
677 | (point)) | |
678 | `gnus-article-toggle-cited-text | |
679 | args) | |
680 | (point)) | |
681 | 'article-type 'annotation))))) | |
eec82323 LMI |
682 | |
683 | (defun gnus-article-hide-citation-maybe (&optional arg force) | |
684 | "Toggle hiding of cited text that has an attribution line. | |
685 | If given a negative prefix, always show; if given a positive prefix, | |
686 | always hide. | |
687 | This will do nothing unless at least `gnus-cite-hide-percentage' | |
688 | percent and at least `gnus-cite-hide-absolute' lines of the body is | |
689 | cited text with attributions. When called interactively, these two | |
690 | variables are ignored. | |
691 | See also the documentation for `gnus-article-highlight-citation'." | |
6748645f | 692 | (interactive (append (gnus-article-hidden-arg) '(force))) |
23f87bed MB |
693 | (with-current-buffer gnus-article-buffer |
694 | (gnus-delete-wash-type 'cite) | |
695 | (unless (gnus-article-check-hidden-text 'cite arg) | |
696 | (save-excursion | |
697 | (gnus-cite-parse-maybe force) | |
698 | (article-goto-body) | |
699 | (let ((start (point)) | |
700 | (atts gnus-cite-attribution-alist) | |
701 | (buffer-read-only nil) | |
702 | (inhibit-point-motion-hooks t) | |
703 | (hidden 0) | |
704 | total) | |
705 | (goto-char (point-max)) | |
706 | (gnus-article-search-signature) | |
707 | (setq total (count-lines start (point))) | |
eec82323 | 708 | (while atts |
23f87bed MB |
709 | (setq hidden (+ hidden (length (cdr (assoc (cdar atts) |
710 | gnus-cite-prefix-alist)))) | |
711 | atts (cdr atts))) | |
712 | (when (or force | |
713 | (and (> (* 100 hidden) (* gnus-cite-hide-percentage total)) | |
714 | (> hidden gnus-cite-hide-absolute))) | |
715 | (gnus-add-wash-type 'cite) | |
716 | (setq atts gnus-cite-attribution-alist) | |
717 | (while atts | |
718 | (setq total (cdr (assoc (cdar atts) gnus-cite-prefix-alist)) | |
719 | atts (cdr atts)) | |
720 | (while total | |
721 | (setq hidden (car total) | |
722 | total (cdr total)) | |
723 | (goto-char (point-min)) | |
724 | (forward-line (1- hidden)) | |
725 | (unless (assq hidden gnus-cite-attribution-alist) | |
726 | (gnus-add-text-properties | |
727 | (point) (progn (forward-line 1) (point)) | |
728 | (nconc (list 'article-type 'cite) | |
729 | gnus-hidden-properties))))))))) | |
730 | (gnus-set-mode-line 'article))) | |
eec82323 LMI |
731 | |
732 | (defun gnus-article-hide-citation-in-followups () | |
733 | "Hide cited text in non-root articles." | |
734 | (interactive) | |
735 | (save-excursion | |
736 | (set-buffer gnus-article-buffer) | |
737 | (let ((article (cdr gnus-article-current))) | |
738 | (unless (save-excursion | |
739 | (set-buffer gnus-summary-buffer) | |
740 | (gnus-article-displayed-root-p article)) | |
741 | (gnus-article-hide-citation))))) | |
742 | ||
743 | ;;; Internal functions: | |
744 | ||
16409b0b GM |
745 | (defun gnus-cite-parse-maybe (&optional force no-overlay) |
746 | "Always parse the buffer." | |
747 | (gnus-cite-localize) | |
748 | ;;Reset parser information. | |
749 | (setq gnus-cite-prefix-alist nil | |
750 | gnus-cite-attribution-alist nil | |
751 | gnus-cite-loose-prefix-alist nil | |
752 | gnus-cite-loose-attribution-alist nil) | |
753 | (unless no-overlay | |
754 | (gnus-cite-delete-overlays)) | |
755 | ;; Parse if not too large. | |
756 | (if (and gnus-cite-parse-max-size | |
757 | (> (buffer-size) gnus-cite-parse-max-size)) | |
eec82323 | 758 | () |
16409b0b GM |
759 | (setq gnus-cite-article (cons (car gnus-article-current) |
760 | (cdr gnus-article-current))) | |
761 | (gnus-cite-parse-wrapper))) | |
762 | ||
763 | (defun gnus-cite-delete-overlays () | |
764 | (dolist (overlay gnus-cite-overlay-list) | |
23f87bed MB |
765 | (ignore-errors |
766 | (when (or (not (gnus-overlay-end overlay)) | |
767 | (and (>= (gnus-overlay-end overlay) (point-min)) | |
768 | (<= (gnus-overlay-end overlay) (point-max)))) | |
769 | (setq gnus-cite-overlay-list (delete overlay gnus-cite-overlay-list)) | |
770 | (ignore-errors | |
771 | (gnus-delete-overlay overlay)))))) | |
eec82323 LMI |
772 | |
773 | (defun gnus-cite-parse-wrapper () | |
16409b0b GM |
774 | ;; Wrap chopped gnus-cite-parse. |
775 | (article-goto-body) | |
776 | (let ((inhibit-point-motion-hooks t)) | |
777 | (save-excursion | |
778 | (gnus-cite-parse-attributions)) | |
779 | (save-excursion | |
780 | (gnus-cite-parse)) | |
781 | (save-excursion | |
782 | (gnus-cite-connect-attributions)))) | |
eec82323 LMI |
783 | |
784 | (defun gnus-cite-parse () | |
785 | ;; Parse and connect citation prefixes and attribution lines. | |
786 | ||
787 | ;; Parse current buffer searching for citation prefixes. | |
788 | (let ((line (1+ (count-lines (point-min) (point)))) | |
789 | (case-fold-search t) | |
790 | (max (save-excursion | |
791 | (goto-char (point-max)) | |
792 | (gnus-article-search-signature) | |
793 | (point))) | |
23f87bed MB |
794 | (prefix-regexp (concat "^\\(" message-cite-prefix-regexp "\\)")) |
795 | alist entry start begin end numbers prefix guess-limit) | |
eec82323 LMI |
796 | ;; Get all potential prefixes in `alist'. |
797 | (while (< (point) max) | |
798 | ;; Each line. | |
799 | (setq begin (point) | |
23f87bed | 800 | guess-limit (progn (skip-chars-forward "^> \t\r\n") (point)) |
01c52d31 | 801 | end (point-at-bol 2) |
eec82323 LMI |
802 | start end) |
803 | (goto-char begin) | |
804 | ;; Ignore standard Supercite attribution prefix. | |
23f87bed MB |
805 | (when (and (< guess-limit (+ begin gnus-cite-max-prefix)) |
806 | (looking-at gnus-supercite-regexp)) | |
eec82323 LMI |
807 | (if (match-end 1) |
808 | (setq end (1+ (match-end 1))) | |
809 | (setq end (1+ begin)))) | |
810 | ;; Ignore very long prefixes. | |
23f87bed MB |
811 | (when (> end (+ begin gnus-cite-max-prefix)) |
812 | (setq end (+ begin gnus-cite-max-prefix))) | |
813 | ;; Ignore quoted envelope From_. | |
814 | (when (and gnus-cite-ignore-quoted-from | |
815 | (prog2 | |
816 | (setq case-fold-search nil) | |
817 | (looking-at ">From ") | |
818 | (setq case-fold-search t))) | |
819 | (setq end (1+ begin))) | |
820 | (while (re-search-forward prefix-regexp (1- end) t) | |
eec82323 LMI |
821 | ;; Each prefix. |
822 | (setq end (match-end 0) | |
823 | prefix (buffer-substring begin end)) | |
01c52d31 | 824 | (set-text-properties 0 (length prefix) nil prefix) |
eec82323 LMI |
825 | (setq entry (assoc prefix alist)) |
826 | (if entry | |
827 | (setcdr entry (cons line (cdr entry))) | |
828 | (push (list prefix line) alist)) | |
829 | (goto-char begin)) | |
830 | (goto-char start) | |
831 | (setq line (1+ line))) | |
23f87bed MB |
832 | ;; Horrible special case for some Microsoft mailers. |
833 | (goto-char (point-min)) | |
01c52d31 MB |
834 | (setq start t begin nil entry nil) |
835 | (while start | |
836 | ;; Assume this search ends up at the beginning of a line. | |
837 | (if (re-search-forward gnus-cite-unsightly-citation-regexp max t) | |
838 | (progn | |
839 | (when (number-or-marker-p start) | |
840 | (setq begin (count-lines (point-min) start) | |
841 | end (count-lines (point-min) (match-beginning 0)))) | |
842 | (setq start (match-end 0))) | |
843 | (when (number-or-marker-p start) | |
844 | (setq begin (count-lines (point-min) start) | |
845 | end (count-lines (point-min) max))) | |
846 | (setq start nil)) | |
847 | (when begin | |
848 | (while (< begin end) | |
849 | ;; Need to do 1+ because we're in the bol. | |
850 | (push (setq begin (1+ begin)) entry)))) | |
851 | (when entry | |
23f87bed | 852 | (push (cons "" entry) alist)) |
eec82323 LMI |
853 | ;; We got all the potential prefixes. Now create |
854 | ;; `gnus-cite-prefix-alist' containing the oldest prefix for each | |
23f87bed | 855 | ;; line that appears at least `gnus-cite-minimum-match-count' |
eec82323 LMI |
856 | ;; times. First sort them by length. Longer is older. |
857 | (setq alist (sort alist (lambda (a b) | |
858 | (> (length (car a)) (length (car b)))))) | |
859 | (while alist | |
860 | (setq entry (car alist) | |
861 | prefix (car entry) | |
862 | numbers (cdr entry) | |
863 | alist (cdr alist)) | |
864 | (cond ((null numbers) | |
865 | ;; No lines with this prefix that wasn't also part of | |
866 | ;; a longer prefix. | |
867 | ) | |
868 | ((< (length numbers) gnus-cite-minimum-match-count) | |
869 | ;; Too few lines with this prefix. We keep it a bit | |
870 | ;; longer in case it is an exact match for an attribution | |
871 | ;; line, but we don't remove the line from other | |
872 | ;; prefixes. | |
873 | (push entry gnus-cite-prefix-alist)) | |
874 | (t | |
875 | (push entry | |
876 | gnus-cite-prefix-alist) | |
877 | ;; Remove articles from other prefixes. | |
878 | (let ((loop alist) | |
879 | current) | |
880 | (while loop | |
881 | (setq current (car loop) | |
882 | loop (cdr loop)) | |
883 | (setcdr current | |
884 | (gnus-set-difference (cdr current) numbers))))))))) | |
885 | ||
886 | (defun gnus-cite-parse-attributions () | |
887 | (let (al-alist) | |
888 | ;; Parse attributions | |
889 | (while (re-search-forward gnus-cite-attribution-suffix (point-max) t) | |
890 | (let* ((start (match-beginning 0)) | |
891 | (end (match-end 0)) | |
892 | (wrote (count-lines (point-min) end)) | |
893 | (prefix (gnus-cite-find-prefix wrote)) | |
894 | ;; Check previous line for an attribution leader. | |
895 | (tag (progn | |
896 | (beginning-of-line 1) | |
897 | (when (looking-at gnus-supercite-secondary-regexp) | |
898 | (buffer-substring (match-beginning 1) | |
899 | (match-end 1))))) | |
900 | (in (progn | |
901 | (goto-char start) | |
902 | (and (re-search-backward gnus-cite-attribution-prefix | |
903 | (save-excursion | |
904 | (beginning-of-line 0) | |
905 | (point)) | |
906 | t) | |
907 | (not (re-search-forward gnus-cite-attribution-suffix | |
908 | start t)) | |
909 | (count-lines (point-min) (1+ (point))))))) | |
910 | (when (eq wrote in) | |
911 | (setq in nil)) | |
912 | (goto-char end) | |
913 | ;; don't add duplicates | |
914 | (let ((al (buffer-substring (save-excursion (beginning-of-line 0) | |
915 | (1+ (point))) | |
916 | end))) | |
01c52d31 MB |
917 | (when (not (assoc al al-alist)) |
918 | (push (list wrote in prefix tag) | |
919 | gnus-cite-loose-attribution-alist) | |
920 | (push (cons al t) al-alist))))))) | |
eec82323 LMI |
921 | |
922 | (defun gnus-cite-connect-attributions () | |
923 | ;; Connect attributions to citations | |
924 | ||
925 | ;; No citations have been connected to attribution lines yet. | |
926 | (setq gnus-cite-loose-prefix-alist (append gnus-cite-prefix-alist nil)) | |
927 | ||
928 | ;; Parse current buffer searching for attribution lines. | |
929 | ;; Find exact supercite citations. | |
930 | (gnus-cite-match-attributions 'small nil | |
931 | (lambda (prefix tag) | |
932 | (when tag | |
933 | (concat "\\`" | |
934 | (regexp-quote prefix) "[ \t]*" | |
935 | (regexp-quote tag) ">")))) | |
936 | ;; Find loose supercite citations after attributions. | |
937 | (gnus-cite-match-attributions 'small t | |
938 | (lambda (prefix tag) | |
939 | (when tag | |
940 | (concat "\\<" | |
941 | (regexp-quote tag) | |
942 | "\\>")))) | |
943 | ;; Find loose supercite citations anywhere. | |
944 | (gnus-cite-match-attributions 'small nil | |
945 | (lambda (prefix tag) | |
946 | (when tag | |
947 | (concat "\\<" | |
948 | (regexp-quote tag) | |
949 | "\\>")))) | |
950 | ;; Find nested citations after attributions. | |
951 | (gnus-cite-match-attributions 'small-if-unique t | |
952 | (lambda (prefix tag) | |
953 | (concat "\\`" (regexp-quote prefix) ".+"))) | |
954 | ;; Find nested citations anywhere. | |
955 | (gnus-cite-match-attributions 'small nil | |
956 | (lambda (prefix tag) | |
957 | (concat "\\`" (regexp-quote prefix) ".+"))) | |
958 | ;; Remove loose prefixes with too few lines. | |
959 | (let ((alist gnus-cite-loose-prefix-alist) | |
960 | entry) | |
961 | (while alist | |
962 | (setq entry (car alist) | |
963 | alist (cdr alist)) | |
964 | (when (< (length (cdr entry)) gnus-cite-minimum-match-count) | |
965 | (setq gnus-cite-prefix-alist | |
966 | (delq entry gnus-cite-prefix-alist) | |
967 | gnus-cite-loose-prefix-alist | |
968 | (delq entry gnus-cite-loose-prefix-alist))))) | |
969 | ;; Find flat attributions. | |
970 | (gnus-cite-match-attributions 'first t nil) | |
971 | ;; Find any attributions (are we getting desperate yet?). | |
972 | (gnus-cite-match-attributions 'first nil nil)) | |
973 | ||
974 | (defun gnus-cite-match-attributions (sort after fun) | |
975 | ;; Match all loose attributions and citations (SORT AFTER FUN) . | |
976 | ;; | |
977 | ;; If SORT is `small', the citation with the shortest prefix will be | |
978 | ;; used, if it is `first' the first prefix will be used, if it is | |
979 | ;; `small-if-unique' the shortest prefix will be used if the | |
980 | ;; attribution line does not share its own prefix with other | |
981 | ;; loose attribution lines, otherwise the first prefix will be used. | |
982 | ;; | |
983 | ;; If AFTER is non-nil, only citations after the attribution line | |
984 | ;; will be considered. | |
985 | ;; | |
986 | ;; If FUN is non-nil, it will be called with the arguments (WROTE | |
987 | ;; PREFIX TAG) and expected to return a regular expression. Only | |
988 | ;; citations whose prefix matches the regular expression will be | |
989 | ;; considered. | |
990 | ;; | |
991 | ;; WROTE is the attribution line number. | |
992 | ;; PREFIX is the attribution line prefix. | |
993 | ;; TAG is the Supercite tag on the attribution line. | |
994 | (let ((atts gnus-cite-loose-attribution-alist) | |
995 | (case-fold-search t) | |
996 | att wrote in prefix tag regexp limit smallest best size) | |
997 | (while atts | |
998 | (setq att (car atts) | |
999 | atts (cdr atts) | |
1000 | wrote (nth 0 att) | |
1001 | in (nth 1 att) | |
1002 | prefix (nth 2 att) | |
1003 | tag (nth 3 att) | |
1004 | regexp (if fun (funcall fun prefix tag) "") | |
1005 | size (cond ((eq sort 'small) t) | |
1006 | ((eq sort 'first) nil) | |
1007 | (t (< (length (gnus-cite-find-loose prefix)) 2))) | |
1008 | limit (if after wrote -1) | |
1009 | smallest 1000000 | |
1010 | best nil) | |
1011 | (let ((cites gnus-cite-loose-prefix-alist) | |
1012 | cite candidate numbers first compare) | |
1013 | (while cites | |
1014 | (setq cite (car cites) | |
1015 | cites (cdr cites) | |
1016 | candidate (car cite) | |
1017 | numbers (cdr cite) | |
1018 | first (apply 'min numbers) | |
1019 | compare (if size (length candidate) first)) | |
1020 | (and (> first limit) | |
1021 | regexp | |
1022 | (string-match regexp candidate) | |
1023 | (< compare smallest) | |
1024 | (setq best cite | |
1025 | smallest compare)))) | |
1026 | (if (null best) | |
1027 | () | |
1028 | (setq gnus-cite-loose-attribution-alist | |
1029 | (delq att gnus-cite-loose-attribution-alist)) | |
1030 | (push (cons wrote (car best)) gnus-cite-attribution-alist) | |
1031 | (when in | |
1032 | (push (cons in (car best)) gnus-cite-attribution-alist)) | |
1033 | (when (memq best gnus-cite-loose-prefix-alist) | |
1034 | (let ((loop gnus-cite-prefix-alist) | |
1035 | (numbers (cdr best)) | |
1036 | current) | |
1037 | (setq gnus-cite-loose-prefix-alist | |
1038 | (delq best gnus-cite-loose-prefix-alist)) | |
1039 | (while loop | |
1040 | (setq current (car loop) | |
1041 | loop (cdr loop)) | |
1042 | (if (eq current best) | |
1043 | () | |
1044 | (setcdr current (gnus-set-difference (cdr current) numbers)) | |
1045 | (when (null (cdr current)) | |
1046 | (setq gnus-cite-loose-prefix-alist | |
1047 | (delq current gnus-cite-loose-prefix-alist) | |
1048 | atts (delq current atts))))))))))) | |
1049 | ||
1050 | (defun gnus-cite-find-loose (prefix) | |
1051 | ;; Return a list of loose attribution lines prefixed by PREFIX. | |
1052 | (let* ((atts gnus-cite-loose-attribution-alist) | |
1053 | att line lines) | |
1054 | (while atts | |
1055 | (setq att (car atts) | |
1056 | line (car att) | |
1057 | atts (cdr atts)) | |
1058 | (when (string-equal (gnus-cite-find-prefix line) prefix) | |
1059 | (push line lines))) | |
1060 | lines)) | |
1061 | ||
1062 | (defun gnus-cite-add-face (number prefix face) | |
1063 | ;; At line NUMBER, ignore PREFIX and add FACE to the rest of the line. | |
1064 | (when face | |
1065 | (let ((inhibit-point-motion-hooks t) | |
6748645f | 1066 | from to overlay) |
16409b0b GM |
1067 | (goto-char (point-min)) |
1068 | (when (zerop (forward-line (1- number))) | |
eec82323 LMI |
1069 | (forward-char (length prefix)) |
1070 | (skip-chars-forward " \t") | |
1071 | (setq from (point)) | |
1072 | (end-of-line 1) | |
1073 | (skip-chars-backward " \t") | |
1074 | (setq to (point)) | |
1075 | (when (< from to) | |
6748645f LMI |
1076 | (push (setq overlay (gnus-make-overlay from to)) |
1077 | gnus-cite-overlay-list) | |
c1b1a4f3 | 1078 | (gnus-overlay-put overlay 'evaporate t) |
6748645f | 1079 | (gnus-overlay-put overlay 'face face)))))) |
eec82323 LMI |
1080 | |
1081 | (defun gnus-cite-toggle (prefix) | |
1082 | (save-excursion | |
1083 | (set-buffer gnus-article-buffer) | |
16409b0b | 1084 | (gnus-cite-parse-maybe nil t) |
eec82323 LMI |
1085 | (let ((buffer-read-only nil) |
1086 | (numbers (cdr (assoc prefix gnus-cite-prefix-alist))) | |
1087 | (inhibit-point-motion-hooks t) | |
1088 | number) | |
1089 | (while numbers | |
1090 | (setq number (car numbers) | |
1091 | numbers (cdr numbers)) | |
16409b0b GM |
1092 | (goto-char (point-min)) |
1093 | (forward-line (1- number)) | |
eec82323 | 1094 | (cond ((get-text-property (point) 'invisible) |
23f87bed MB |
1095 | ;; Can't remove 'cite from g-a-wash-types here because |
1096 | ;; multiple citations may be hidden -jas | |
eec82323 LMI |
1097 | (remove-text-properties (point) (progn (forward-line 1) (point)) |
1098 | gnus-hidden-properties)) | |
1099 | ((assq number gnus-cite-attribution-alist)) | |
1100 | (t | |
23f87bed | 1101 | (gnus-add-wash-type 'cite) |
eec82323 LMI |
1102 | (gnus-add-text-properties |
1103 | (point) (progn (forward-line 1) (point)) | |
1104 | (nconc (list 'article-type 'cite) | |
23f87bed MB |
1105 | gnus-hidden-properties)))) |
1106 | (let ((gnus-article-mime-handle-alist-1 | |
1107 | gnus-article-mime-handle-alist)) | |
1108 | (gnus-set-mode-line 'article)))))) | |
eec82323 LMI |
1109 | |
1110 | (defun gnus-cite-find-prefix (line) | |
1111 | ;; Return citation prefix for LINE. | |
1112 | (let ((alist gnus-cite-prefix-alist) | |
1113 | (prefix "") | |
1114 | entry) | |
1115 | (while alist | |
1116 | (setq entry (car alist) | |
1117 | alist (cdr alist)) | |
1118 | (when (memq line (cdr entry)) | |
1119 | (setq prefix (car entry)))) | |
1120 | prefix)) | |
1121 | ||
6748645f LMI |
1122 | (defun gnus-cite-localize () |
1123 | "Make the citation variables local to the article buffer." | |
1124 | (let ((vars '(gnus-cite-article | |
1125 | gnus-cite-overlay-list gnus-cite-prefix-alist | |
1126 | gnus-cite-attribution-alist gnus-cite-loose-prefix-alist | |
1127 | gnus-cite-loose-attribution-alist))) | |
1128 | (while vars | |
1129 | (make-local-variable (pop vars))))) | |
eec82323 | 1130 | |
23f87bed MB |
1131 | (defun gnus-cited-line-p () |
1132 | "Say whether the current line is a cited line." | |
1133 | (save-excursion | |
1134 | (beginning-of-line) | |
1135 | (let ((found nil)) | |
1136 | (dolist (prefix (mapcar 'car gnus-cite-prefix-alist)) | |
1137 | (when (string= (buffer-substring (point) (+ (length prefix) (point))) | |
1138 | prefix) | |
1139 | (setq found t))) | |
1140 | found))) | |
1141 | ||
01c52d31 MB |
1142 | |
1143 | ;; Highlighting of different citation levels in message-mode. | |
1144 | ;; - message-cite-prefix will be overridden if this is enabled. | |
1145 | ||
1146 | (defvar gnus-message-max-citation-depth | |
1147 | (length gnus-cite-face-list) | |
1148 | "Maximum supported level of citation.") | |
1149 | ||
1150 | (defvar gnus-message-cite-prefix-regexp | |
1151 | (concat "^\\(?:" message-cite-prefix-regexp "\\)")) | |
1152 | ||
1153 | (defun gnus-message-search-citation-line (limit) | |
1154 | "Search for a cited line and set match data accordingly. | |
1155 | Returns nil if there is no such line before LIMIT, t otherwise." | |
1156 | (when (re-search-forward gnus-message-cite-prefix-regexp limit t) | |
1157 | (let ((cdepth (min (length (apply 'concat | |
1158 | (split-string | |
1159 | (match-string-no-properties 0) | |
1160 | "[ \t [:alnum:]]+"))) | |
1161 | gnus-message-max-citation-depth)) | |
1162 | (mlist (make-list (* (1+ gnus-message-max-citation-depth) 2) nil)) | |
1163 | (start (point-at-bol)) | |
1164 | (end (point-at-eol))) | |
1165 | (setcar mlist start) | |
1166 | (setcar (cdr mlist) end) | |
1167 | (setcar (nthcdr (* cdepth 2) mlist) start) | |
1168 | (setcar (nthcdr (1+ (* cdepth 2)) mlist) end) | |
1169 | (set-match-data mlist)) | |
1170 | t)) | |
1171 | ||
1172 | (defvar gnus-message-citation-keywords | |
1173 | ;; eval-when-compile ;; This breaks in XEmacs | |
1174 | `((gnus-message-search-citation-line | |
1175 | ,@(let ((list nil) | |
1176 | (count 1)) | |
1177 | ;; (require 'gnus-cite) | |
1178 | (dolist (face gnus-cite-face-list (nreverse list)) | |
1179 | (push (list count (list 'quote face) 'prepend t) list) | |
1180 | (setq count (1+ count)))))) ;; | |
1181 | "Keywords for highlighting different levels of message citations.") | |
1182 | ||
9efa445f DN |
1183 | (defvar font-lock-defaults-computed) |
1184 | (defvar font-lock-keywords) | |
1185 | (defvar font-lock-set-defaults) | |
01c52d31 MB |
1186 | |
1187 | (eval-and-compile | |
1188 | (unless (featurep 'xemacs) | |
1189 | (autoload 'font-lock-set-defaults "font-lock"))) | |
1190 | ||
1191 | (define-minor-mode gnus-message-citation-mode | |
1192 | "Toggle `gnus-message-citation-mode' in current buffer. | |
1193 | This buffer local minor mode provides additional font-lock support for | |
1194 | nested citations. | |
1195 | With prefix ARG, turn `gnus-message-citation-mode' on if and only if ARG | |
1196 | is positive. | |
1197 | Automatically turn `font-lock-mode' on when `gnus-message-citation-mode' | |
1198 | is turned on." | |
1199 | nil ;; init-value | |
1200 | "" ;; lighter | |
1201 | nil ;; keymap | |
1202 | (when (eq major-mode 'message-mode) | |
1203 | (let ((defaults (car (if (featurep 'xemacs) | |
1204 | (get 'message-mode 'font-lock-defaults) | |
1205 | font-lock-defaults))) | |
1206 | default keywords) | |
1207 | (while defaults | |
1208 | (setq default (if (consp defaults) | |
1209 | (pop defaults) | |
1210 | (prog1 | |
1211 | defaults | |
1212 | (setq defaults nil)))) | |
1213 | (if gnus-message-citation-mode | |
1214 | ;; `gnus-message-citation-keywords' should be the last | |
1215 | ;; elements of the keywords because the others are unlikely | |
1216 | ;; to have the OVERRIDE flags -- XEmacs applies a keyword | |
1217 | ;; having no OVERRIDE flag to matched text even if it has | |
1218 | ;; already other faces, while Emacs doesn't. | |
1219 | (set (make-local-variable default) | |
1220 | (append (default-value default) | |
1221 | gnus-message-citation-keywords)) | |
1222 | (kill-local-variable default)))) | |
1223 | ;; Force `font-lock-set-defaults' to update `font-lock-keywords'. | |
1224 | (if (featurep 'xemacs) | |
1225 | (progn | |
1226 | (require 'font-lock) | |
1227 | (setq font-lock-defaults-computed nil | |
1228 | font-lock-keywords nil)) | |
1229 | (setq font-lock-set-defaults nil)) | |
1230 | (font-lock-set-defaults) | |
1231 | (cond ((symbol-value 'font-lock-mode) | |
1232 | (font-lock-fontify-buffer)) | |
1233 | (gnus-message-citation-mode | |
1234 | (font-lock-mode 1))))) | |
1235 | ||
1236 | (defun turn-on-gnus-message-citation-mode () | |
1237 | "Turn on `gnus-message-citation-mode'." | |
1238 | (gnus-message-citation-mode 1)) | |
1239 | (defun turn-off-gnus-message-citation-mode () | |
1240 | "Turn off `gnus-message-citation-mode'." | |
1241 | (gnus-message-citation-mode -1)) | |
1242 | ||
eec82323 LMI |
1243 | (gnus-ems-redefine) |
1244 | ||
1245 | (provide 'gnus-cite) | |
1246 | ||
16409b0b GM |
1247 | ;; Local Variables: |
1248 | ;; coding: iso-8859-1 | |
1249 | ;; End: | |
1250 | ||
cbee283d | 1251 | ;; arch-tag: 1997b044-6067-471e-8c8f-dc903093098a |
eec82323 | 1252 | ;;; gnus-cite.el ends here |