| blob | a33f3eab413f2c08849678f2428064bc78ea66ab |
1 ;;; gnus-cite.el --- parse citations in articles for Gnus
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011 Free Software Foundation, Inc.
6 ;; Author: Per Abhiddenware
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;;; Code:
37 ;;; Customization:
40 "Citation."
46 "Format of opened cited text buttons."
51 "Format of closed cited text buttons."
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."
61 integer
65 "Maximum article size (in bytes) where parsing citations is allowed.
66 Set it to nil to parse all articles."
69 integer))
72 "Maximum possible length for a citation prefix."
79 "*Regexp matching normal Supercite attribution lines.
80 The first grouping must match prefixes added by other packages."
85 "Regexp matching mangled Supercite attribution lines.
86 The first regexp group should match the Supercite attribution."
91 "Minimum number of identical prefixes before we believe it's a citation."
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.
113 "In article\\|in <\\|On \\(Mon\\|Tue\\|Wed\\|Thu\\|Fri\\|Sat\\|Sun\\),\\|----- ?Original Message ?-----"
114 "*Regexp matching the beginning of an attribution line."
119 "\\(\\(wrote\\|writes\\|said\\|says\\|>\\)\\(:\\|\\.\\.\\.\\)\\|----- ?Original Message ?-----\\)[ \t]*$"
120 "*Regexp matching the end of an attribution line.
121 The text matching the first grouping will be used as a button."
127 "Regexp matching Microsoft-type rest-of-message citations."
134 Those lines may have been quoted by MTAs in order not to mix up with
135 the envelope From line."
141 "Face used for attribution lines."
143 ;; backward-compatibility alias
148 "Face used for attribution lines.
149 It is merged with the face for the cited text belonging to the attribution."
162 "Citation face."
164 ;; backward-compatibility alias
176 "Citation face."
178 ;; backward-compatibility alias
190 "Citation face."
192 ;; backward-compatibility alias
204 "Citation face."
206 ;; backward-compatibility alias
218 "Citation face."
220 ;; backward-compatibility alias
232 "Citation face."
234 ;; backward-compatibility alias
246 "Citation face."
248 ;; backward-compatibility alias
260 "Citation face."
262 ;; backward-compatibility alias
274 "Citation face."
276 ;; backward-compatibility alias
288 "Citation face."
290 ;; backward-compatibility alias
302 "Citation face."
304 ;; backward-compatibility alias
310 gnus-cite-7 gnus-cite-8 gnus-cite-9 gnus-cite-10 gnus-cite-11)
311 "*List of faces used for highlighting citations.
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."
330 list)
334 "Only hide excess citation if above this percentage of the body."
339 "Only hide excess citation if above this number of lines in the body."
344 "If non-nil, put a blank line between the citation header and the button."
348 ;; This has to go here because its default value depends on
349 ;; gnus-cite-face-list.
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."
358 ;;; Internal Variables:
364 ;; Alist of citation prefixes.
365 ;; The cdr is a list of lines with that prefix.
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.
373 ;; Alist of citation prefixes that have no matching attribution.
374 ;; The cdr is a list of lines with that prefix.
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.
391 gnus-cited-opened-text-button-line-format-alist)
395 ;;; Commands:
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
402 corresponding citation merged with the face `gnus-cite-attribution'.
404 Text is considered cited if at least `gnus-cite-minimum-match-count'
405 lines matches `message-cite-prefix-regexp' with the same prefix.
407 Lines matching `gnus-cite-attribution-suffix' and perhaps
408 `gnus-cite-attribution-prefix' are considered attribution lines."
418 face entry prefix skip numbers number face-alist)
419 ;; Loop through citation prefixes.
434 ;; Loop through attribution lines.
443 ;; Add attribution button.
448 t)
451 ;; Highlight attribution line.
454 ;; Loop through attribution lines.
464 "Dissect the article buffer looking for cited text."
469 prefix numbers number marks m)
470 ;; Loop through citation prefixes.
485 ;; Skip to the beginning of the body.
488 ;; Find the end of the body.
492 ;; Sort the marks.
520 marks))))
523 "Do word wrapping in the current article.
524 If WIDTH (the numerical prefix), use that text width when filling."
542 use-hard-newlines)
548 ;; All this information is now incorrect.
550 gnus-cite-attribution-alist nil
551 gnus-cite-loose-prefix-alist nil
552 gnus-cite-loose-attribution-alist nil
553 gnus-cite-article nil)))))
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."
566 marks
569 gnus-hidden-properties))
571 found beg end start)
574 'gnus-callback
586 end nil)
595 ;; Skip past lines we want to leave visible.
600 gnus-cited-lines-visible))
612 ;; We use markers for the end-points to facilitate later
613 ;; wrapping and mangling of text.
628 `gnus-article-toggle-cited-text
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."
645 buffer-read-only)
652 ;; Can't remove 'cite from g-a-wash-types here because
653 ;; multiple citations may be hidden -jas
657 gnus-hidden-properties))))
660 'article-type nil beg end
662 gnus-hidden-properties))))
675 gnus-cited-opened-text-button-line-format-spec
676 gnus-cited-closed-text-button-line-format-spec))
678 `gnus-article-toggle-cited-text
679 args)
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'."
704 total)
710 gnus-cite-prefix-alist))))
729 gnus-hidden-properties)))))))))
733 "Hide cited text in non-root articles."
743 ;;; Internal functions:
746 "Always parse the buffer."
748 ;;Reset parser information.
750 gnus-cite-attribution-alist nil
751 gnus-cite-loose-prefix-alist nil
752 gnus-cite-loose-attribution-alist nil)
755 ;; Parse if not too large.
758 ()
774 ;; Wrap chopped gnus-cite-parse.
785 ;; Parse and connect citation prefixes and attribution lines.
787 ;; Parse current buffer searching for citation prefixes.
795 alist entry start begin end numbers prefix guess-limit)
796 ;; Get all potential prefixes in `alist'.
798 ;; Each line.
802 start end)
804 ;; Ignore standard Supercite attribution prefix.
810 ;; Ignore very long prefixes.
813 ;; Ignore quoted envelope From_.
821 ;; Each prefix.
832 ;; Horrible special case for some Microsoft mailers.
836 ;; Assume this search ends up at the beginning of a line.
849 ;; Need to do 1+ because we're in the bol.
853 ;; We got all the potential prefixes. Now create
854 ;; `gnus-cite-prefix-alist' containing the oldest prefix for each
855 ;; line that appears at least `gnus-cite-minimum-match-count'
856 ;; times. First sort them by length. Longer is older.
865 ;; No lines with this prefix that wasn't also part of
866 ;; a longer prefix.
867 )
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.
876 gnus-cite-prefix-alist)
877 ;; Remove articles from other prefixes.
879 current)
888 ;; Parse attributions
894 ;; Check previous line for an attribution leader.
906 t)
908 start t))
913 ;; don't add duplicates
916 end)))
919 gnus-cite-loose-attribution-alist)
923 ;; Connect attributions to citations
925 ;; No citations have been connected to attribution lines yet.
928 ;; Parse current buffer searching for attribution lines.
929 ;; Find exact supercite citations.
936 ;; Find loose supercite citations after attributions.
943 ;; Find loose supercite citations anywhere.
950 ;; Find nested citations after attributions.
954 ;; Find nested citations anywhere.
958 ;; Remove loose prefixes with too few lines.
960 entry)
967 gnus-cite-loose-prefix-alist
969 ;; Find flat attributions.
971 ;; Find any attributions (are we getting desperate yet?).
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.
996 att wrote in prefix tag regexp limit smallest best size)
1009 smallest 1000000
1010 best nil)
1012 cite candidate numbers first compare)
1021 regexp
1025 smallest compare))))
1027 ()
1036 current)
1043 ()
1051 ;; Return a list of loose attribution lines prefixed by PREFIX.
1053 att line lines)
1060 lines))
1063 ;; At line NUMBER, ignore PREFIX and add FACE to the rest of the line.
1066 from to overlay)
1077 gnus-cite-overlay-list)
1088 number)
1095 ;; Can't remove 'cite from g-a-wash-types here because
1096 ;; multiple citations may be hidden -jas
1098 gnus-hidden-properties))
1105 gnus-hidden-properties))))
1107 gnus-article-mime-handle-alist))
1111 ;; Return citation prefix for LINE.
1114 entry)
1120 prefix))
1123 "Make the citation variables local to the article buffer."
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)))
1132 "Say whether the current line is a cited line."
1138 prefix)
1140 found)))
1143 ;; Highlighting of different citation levels in message-mode.
1144 ;; - message-cite-prefix will be overridden if this is enabled.
1154 "Search for a cited line and set match data accordingly.
1155 Returns nil if there is no such line before LIMIT, t otherwise."
1161 gnus-message-max-citation-depth))
1170 t))
1173 ;; eval-when-compile ;; This breaks in XEmacs
1177 ;; (require 'gnus-cite)
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
1201 nil ;; keymap
1205 font-lock-defaults)))
1206 default keywords)
1211 defaults
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.
1221 gnus-message-citation-keywords))
1223 ;; Force `font-lock-set-defaults' to update `font-lock-keywords'.
1228 font-lock-keywords nil))
1237 "Turn on `gnus-message-citation-mode'."
1240 "Turn off `gnus-message-citation-mode'."
1247 ;; Local Variables:
1248 ;; coding: iso-8859-1
1249 ;; End:
1251 ;; arch-tag: 1997b044-6067-471e-8c8f-dc903093098a
1252 ;;; gnus-cite.el ends here