| blob | 0b0c530275fcf50dd04f0cb019bc12bb48d7ecb0 |
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 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
147 "Face used for attribution lines.
148 It is merged with the face for the cited text belonging to the attribution."
161 "Citation face."
163 ;; backward-compatibility alias
174 "Citation face."
176 ;; backward-compatibility alias
187 "Citation face."
189 ;; backward-compatibility alias
200 "Citation face."
202 ;; backward-compatibility alias
213 "Citation face."
215 ;; backward-compatibility alias
226 "Citation face."
228 ;; backward-compatibility alias
239 "Citation face."
241 ;; backward-compatibility alias
252 "Citation face."
254 ;; backward-compatibility alias
265 "Citation face."
267 ;; backward-compatibility alias
278 "Citation face."
280 ;; backward-compatibility alias
291 "Citation face."
293 ;; backward-compatibility alias
298 gnus-cite-7 gnus-cite-8 gnus-cite-9 gnus-cite-10 gnus-cite-11)
299 "*List of faces used for highlighting citations.
301 When there are citations from multiple articles in the same message,
302 Gnus will try to give each citation from each article its own face.
303 This should make it easier to see who wrote what."
318 list)
322 "Only hide excess citation if above this percentage of the body."
327 "Only hide excess citation if above this number of lines in the body."
332 "If non-nil, put a blank line between the citation header and the button."
336 ;; This has to go here because its default value depends on
337 ;; gnus-cite-face-list.
339 "List of faces that are not worth reading.
340 If an article has more pages below the one you are looking at, but
341 nothing on those pages is a word of at least three letters that is not
342 in a boring face, then the pages will be skipped."
346 ;;; Internal Variables:
352 ;; Alist of citation prefixes.
353 ;; The cdr is a list of lines with that prefix.
356 ;; Alist of attribution lines.
357 ;; The car is a line number.
358 ;; The cdr is the prefix for the citation started by that line.
361 ;; Alist of citation prefixes that have no matching attribution.
362 ;; The cdr is a list of lines with that prefix.
365 ;; Alist of attribution lines that have no matching citation.
366 ;; Each member has the form (WROTE IN PREFIX TAG), where
367 ;; WROTE: is the attribution line number
368 ;; IN: is the line number of the previous line if part of the same attribution,
369 ;; PREFIX: Is the citation prefix of the attribution line(s), and
370 ;; TAG: Is a Supercite tag, if any.
379 gnus-cited-opened-text-button-line-format-alist)
383 ;;; Commands:
386 "Highlight cited text.
387 Each citation in the article will be highlighted with a different face.
388 The faces are taken from `gnus-cite-face-list'.
389 Attribution lines are highlighted with the same face as the
390 corresponding citation merged with the face `gnus-cite-attribution'.
392 Text is considered cited if at least `gnus-cite-minimum-match-count'
393 lines matches `message-cite-prefix-regexp' with the same prefix.
395 Lines matching `gnus-cite-attribution-suffix' and perhaps
396 `gnus-cite-attribution-prefix' are considered attribution lines."
406 face entry prefix skip numbers number face-alist)
407 ;; Loop through citation prefixes.
422 ;; Loop through attribution lines.
431 ;; Add attribution button.
436 t)
439 ;; Highlight attribution line.
442 ;; Loop through attribution lines.
452 "Dissect the article buffer looking for cited text."
457 prefix numbers number marks m)
458 ;; Loop through citation prefixes.
473 ;; Skip to the beginning of the body.
476 ;; Find the end of the body.
480 ;; Sort the marks.
508 marks))))
511 "Do word wrapping in the current article.
512 If WIDTH (the numerical prefix), use that text width when filling."
530 use-hard-newlines)
536 ;; All this information is now incorrect.
538 gnus-cite-attribution-alist nil
539 gnus-cite-loose-prefix-alist nil
540 gnus-cite-loose-attribution-alist nil
541 gnus-cite-article nil)))))
544 "Toggle hiding of all cited text except attribution lines.
545 See the documentation for `gnus-article-highlight-citation'.
546 If given a negative prefix, always show; if given a positive prefix,
547 always hide."
554 marks
557 gnus-hidden-properties))
559 found beg end start)
562 'gnus-callback
574 end nil)
583 ;; Skip past lines we want to leave visible.
588 gnus-cited-lines-visible))
600 ;; We use markers for the end-points to facilitate later
601 ;; wrapping and mangling of text.
616 `gnus-article-toggle-cited-text
623 "Toggle hiding the text in REGION.
624 ARG can be nil or a number. Positive means hide, negative
625 means show, nil means toggle."
633 buffer-read-only)
640 ;; Can't remove 'cite from g-a-wash-types here because
641 ;; multiple citations may be hidden -jas
645 gnus-hidden-properties))))
648 'article-type nil beg end
650 gnus-hidden-properties))))
663 gnus-cited-opened-text-button-line-format-spec
664 gnus-cited-closed-text-button-line-format-spec))
666 `gnus-article-toggle-cited-text
667 args)
672 "Toggle hiding of cited text that has an attribution line.
673 If given a negative prefix, always show; if given a positive prefix,
674 always hide.
675 This will do nothing unless at least `gnus-cite-hide-percentage'
676 percent and at least `gnus-cite-hide-absolute' lines of the body is
677 cited text with attributions. When called interactively, these two
678 variables are ignored.
679 See also the documentation for `gnus-article-highlight-citation'."
692 total)
698 gnus-cite-prefix-alist))))
717 gnus-hidden-properties)))))))))
721 "Hide cited text in non-root articles."
731 ;;; Internal functions:
734 "Always parse the buffer."
736 ;;Reset parser information.
738 gnus-cite-attribution-alist nil
739 gnus-cite-loose-prefix-alist nil
740 gnus-cite-loose-attribution-alist nil)
743 ;; Parse if not too large.
746 ()
762 ;; Wrap chopped gnus-cite-parse.
773 ;; Parse and connect citation prefixes and attribution lines.
775 ;; Parse current buffer searching for citation prefixes.
783 alist entry start begin end numbers prefix guess-limit)
784 ;; Get all potential prefixes in `alist'.
786 ;; Each line.
790 start end)
792 ;; Ignore standard Supercite attribution prefix.
798 ;; Ignore very long prefixes.
801 ;; Ignore quoted envelope From_.
809 ;; Each prefix.
820 ;; Horrible special case for some Microsoft mailers.
824 ;; Assume this search ends up at the beginning of a line.
837 ;; Need to do 1+ because we're in the bol.
841 ;; We got all the potential prefixes. Now create
842 ;; `gnus-cite-prefix-alist' containing the oldest prefix for each
843 ;; line that appears at least `gnus-cite-minimum-match-count'
844 ;; times. First sort them by length. Longer is older.
853 ;; No lines with this prefix that wasn't also part of
854 ;; a longer prefix.
855 )
857 ;; Too few lines with this prefix. We keep it a bit
858 ;; longer in case it is an exact match for an attribution
859 ;; line, but we don't remove the line from other
860 ;; prefixes.
864 gnus-cite-prefix-alist)
865 ;; Remove articles from other prefixes.
867 current)
876 ;; Parse attributions
882 ;; Check previous line for an attribution leader.
894 t)
896 start t))
901 ;; don't add duplicates
904 end)))
907 gnus-cite-loose-attribution-alist)
911 ;; Connect attributions to citations
913 ;; No citations have been connected to attribution lines yet.
916 ;; Parse current buffer searching for attribution lines.
917 ;; Find exact supercite citations.
924 ;; Find loose supercite citations after attributions.
931 ;; Find loose supercite citations anywhere.
938 ;; Find nested citations after attributions.
942 ;; Find nested citations anywhere.
946 ;; Remove loose prefixes with too few lines.
948 entry)
955 gnus-cite-loose-prefix-alist
957 ;; Find flat attributions.
959 ;; Find any attributions (are we getting desperate yet?).
963 ;; Match all loose attributions and citations (SORT AFTER FUN) .
964 ;;
965 ;; If SORT is `small', the citation with the shortest prefix will be
966 ;; used, if it is `first' the first prefix will be used, if it is
967 ;; `small-if-unique' the shortest prefix will be used if the
968 ;; attribution line does not share its own prefix with other
969 ;; loose attribution lines, otherwise the first prefix will be used.
970 ;;
971 ;; If AFTER is non-nil, only citations after the attribution line
972 ;; will be considered.
973 ;;
974 ;; If FUN is non-nil, it will be called with the arguments (WROTE
975 ;; PREFIX TAG) and expected to return a regular expression. Only
976 ;; citations whose prefix matches the regular expression will be
977 ;; considered.
978 ;;
979 ;; WROTE is the attribution line number.
980 ;; PREFIX is the attribution line prefix.
981 ;; TAG is the Supercite tag on the attribution line.
984 att wrote in prefix tag regexp limit smallest best size)
997 smallest 1000000
998 best nil)
1000 cite candidate numbers first compare)
1009 regexp
1013 smallest compare))))
1015 ()
1024 current)
1031 ()
1039 ;; Return a list of loose attribution lines prefixed by PREFIX.
1041 att line lines)
1048 lines))
1051 ;; At line NUMBER, ignore PREFIX and add FACE to the rest of the line.
1054 from to overlay)
1065 gnus-cite-overlay-list)
1076 number)
1083 ;; Can't remove 'cite from g-a-wash-types here because
1084 ;; multiple citations may be hidden -jas
1086 gnus-hidden-properties))
1093 gnus-hidden-properties))))
1095 gnus-article-mime-handle-alist))
1099 ;; Return citation prefix for LINE.
1102 entry)
1108 prefix))
1111 "Make the citation variables local to the article buffer."
1113 gnus-cite-overlay-list gnus-cite-prefix-alist
1114 gnus-cite-attribution-alist gnus-cite-loose-prefix-alist
1115 gnus-cite-loose-attribution-alist)))
1120 "Say whether the current line is a cited line."
1126 prefix)
1128 found)))
1131 ;; Highlighting of different citation levels in message-mode.
1132 ;; - message-cite-prefix will be overridden if this is enabled.
1142 "Search for a cited line and set match data accordingly.
1143 Returns nil if there is no such line before LIMIT, t otherwise."
1149 gnus-message-max-citation-depth))
1158 t))
1161 ;; eval-when-compile ;; This breaks in XEmacs
1165 ;; (require 'gnus-cite)
1180 "Toggle `gnus-message-citation-mode' in current buffer.
1181 This buffer local minor mode provides additional font-lock support for
1182 nested citations.
1183 With prefix ARG, turn `gnus-message-citation-mode' on if and only if ARG
1184 is positive.
1185 Automatically turn `font-lock-mode' on when `gnus-message-citation-mode'
1186 is turned on."
1187 nil ;; init-value
1189 nil ;; keymap
1193 font-lock-defaults)))
1194 default keywords)
1199 defaults
1202 ;; `gnus-message-citation-keywords' should be the last
1203 ;; elements of the keywords because the others are unlikely
1204 ;; to have the OVERRIDE flags -- XEmacs applies a keyword
1205 ;; having no OVERRIDE flag to matched text even if it has
1206 ;; already other faces, while Emacs doesn't.
1209 gnus-message-citation-keywords))
1211 ;; Force `font-lock-set-defaults' to update `font-lock-keywords'.
1216 font-lock-keywords nil))
1225 "Turn on `gnus-message-citation-mode'."
1228 "Turn off `gnus-message-citation-mode'."
1235 ;; Local Variables:
1236 ;; coding: iso-8859-1
1237 ;; End:
1239 ;; arch-tag: 1997b044-6067-471e-8c8f-dc903093098a
1240 ;;; gnus-cite.el ends here