| blob | 64c0864db78d140bdfbf11377d7438b07cb49b48 |
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, or (at your option)
13 ;; 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; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
25 ;;; Commentary:
27 ;;; Code:
39 ;;; Customization:
42 "Citation."
48 "Format of opened cited text buttons."
53 "Format of closed cited text buttons."
58 "The number of lines of hidden cited text to remain visible.
59 Or a pair (cons) of numbers which are the number of lines at the top
60 and bottom of the text, respectively, to remain visible."
63 integer
67 "Maximum article size (in bytes) where parsing citations is allowed.
68 Set it to nil to parse all articles."
71 integer))
74 "Maximum possible length for a citation prefix."
81 "*Regexp matching normal Supercite attribution lines.
82 The first grouping must match prefixes added by other packages."
87 "Regexp matching mangled Supercite attribution lines.
88 The first regexp group should match the Supercite attribution."
93 "Minimum number of identical prefixes before we believe it's a citation."
97 ;; Some Microsoft products put in a citation that extends to the
98 ;; remainder of the message:
99 ;;
100 ;; -----Original Message-----
101 ;; From: ...
102 ;; To: ...
103 ;; Sent: ... [date, in non-RFC-2822 format]
104 ;; Subject: ...
105 ;;
106 ;; Cited message, with no prefixes
107 ;;
108 ;; The four headers are always the same. But note they are prone to
109 ;; folding without additional indentation.
110 ;;
111 ;; Others use "----- Original Message -----" instead, and properly quote
112 ;; the body using "> ". This style is handled without special cases.
115 "In article\\|in <\\|On \\(Mon\\|Tue\\|Wed\\|Thu\\|Fri\\|Sat\\|Sun\\),\\|----- ?Original Message ?-----"
116 "*Regexp matching the beginning of an attribution line."
121 "\\(\\(wrote\\|writes\\|said\\|says\\|>\\)\\(:\\|\\.\\.\\.\\)\\|----- ?Original Message ?-----\\)[ \t]*$"
122 "*Regexp matching the end of an attribution line.
123 The text matching the first grouping will be used as a button."
129 "Regexp matching Microsoft-type rest-of-message citations."
136 Those lines may have been quoted by MTAs in order not to mix up with
137 the envelope From line."
143 "Face used for attribution lines."
145 ;; backward-compatibility alias
149 "Face used for attribution lines.
150 It is merged with the face for the cited text belonging to the attribution."
163 "Citation face."
165 ;; backward-compatibility alias
176 "Citation face."
178 ;; backward-compatibility alias
189 "Citation face."
191 ;; backward-compatibility alias
202 "Citation face."
204 ;; backward-compatibility alias
215 "Citation face."
217 ;; backward-compatibility alias
228 "Citation face."
230 ;; backward-compatibility alias
241 "Citation face."
243 ;; backward-compatibility alias
254 "Citation face."
256 ;; backward-compatibility alias
267 "Citation face."
269 ;; backward-compatibility alias
280 "Citation face."
282 ;; backward-compatibility alias
293 "Citation face."
295 ;; backward-compatibility alias
300 gnus-cite-7 gnus-cite-8 gnus-cite-9 gnus-cite-10 gnus-cite-11)
301 "*List of faces used for highlighting citations.
303 When there are citations from multiple articles in the same message,
304 Gnus will try to give each citation from each article its own face.
305 This should make it easier to see who wrote what."
320 list)
324 "Only hide excess citation if above this percentage of the body."
329 "Only hide excess citation if above this number of lines in the body."
334 "If non-nil, put a blank line between the citation header and the button."
338 ;; This has to go here because its default value depends on
339 ;; gnus-cite-face-list.
341 "List of faces that are not worth reading.
342 If an article has more pages below the one you are looking at, but
343 nothing on those pages is a word of at least three letters that is not
344 in a boring face, then the pages will be skipped."
348 ;;; Internal Variables:
354 ;; Alist of citation prefixes.
355 ;; The cdr is a list of lines with that prefix.
358 ;; Alist of attribution lines.
359 ;; The car is a line number.
360 ;; The cdr is the prefix for the citation started by that line.
363 ;; Alist of citation prefixes that have no matching attribution.
364 ;; The cdr is a list of lines with that prefix.
367 ;; Alist of attribution lines that have no matching citation.
368 ;; Each member has the form (WROTE IN PREFIX TAG), where
369 ;; WROTE: is the attribution line number
370 ;; IN: is the line number of the previous line if part of the same attribution,
371 ;; PREFIX: Is the citation prefix of the attribution line(s), and
372 ;; TAG: Is a Supercite tag, if any.
381 gnus-cited-opened-text-button-line-format-alist)
385 ;;; Commands:
388 "Highlight cited text.
389 Each citation in the article will be highlighted with a different face.
390 The faces are taken from `gnus-cite-face-list'.
391 Attribution lines are highlighted with the same face as the
392 corresponding citation merged with the face `gnus-cite-attribution'.
394 Text is considered cited if at least `gnus-cite-minimum-match-count'
395 lines matches `message-cite-prefix-regexp' with the same prefix.
397 Lines matching `gnus-cite-attribution-suffix' and perhaps
398 `gnus-cite-attribution-prefix' are considered attribution lines."
408 face entry prefix skip numbers number face-alist)
409 ;; Loop through citation prefixes.
424 ;; Loop through attribution lines.
433 ;; Add attribution button.
438 t)
441 ;; Highlight attribution line.
444 ;; Loop through attribution lines.
454 "Dissect the article buffer looking for cited text."
459 prefix numbers number marks m)
460 ;; Loop through citation prefixes.
475 ;; Skip to the beginning of the body.
478 ;; Find the end of the body.
482 ;; Sort the marks.
510 marks))))
513 "Do word wrapping in the current article.
514 If WIDTH (the numerical prefix), use that text width when filling."
532 use-hard-newlines)
538 ;; All this information is now incorrect.
540 gnus-cite-attribution-alist nil
541 gnus-cite-loose-prefix-alist nil
542 gnus-cite-loose-attribution-alist nil
543 gnus-cite-article nil)))))
546 "Toggle hiding of all cited text except attribution lines.
547 See the documentation for `gnus-article-highlight-citation'.
548 If given a negative prefix, always show; if given a positive prefix,
549 always hide."
556 marks
559 gnus-hidden-properties))
561 found beg end start)
564 'gnus-callback
576 end nil)
585 ;; Skip past lines we want to leave visible.
590 gnus-cited-lines-visible))
602 ;; We use markers for the end-points to facilitate later
603 ;; wrapping and mangling of text.
618 `gnus-article-toggle-cited-text
625 "Toggle hiding the text in REGION.
626 ARG can be nil or a number. Positive means hide, negative
627 means show, nil means toggle."
635 buffer-read-only)
642 ;; Can't remove 'cite from g-a-wash-types here because
643 ;; multiple citations may be hidden -jas
647 gnus-hidden-properties))))
650 'article-type nil beg end
652 gnus-hidden-properties))))
665 gnus-cited-opened-text-button-line-format-spec
666 gnus-cited-closed-text-button-line-format-spec))
668 `gnus-article-toggle-cited-text
669 args)
674 "Toggle hiding of cited text that has an attribution line.
675 If given a negative prefix, always show; if given a positive prefix,
676 always hide.
677 This will do nothing unless at least `gnus-cite-hide-percentage'
678 percent and at least `gnus-cite-hide-absolute' lines of the body is
679 cited text with attributions. When called interactively, these two
680 variables are ignored.
681 See also the documentation for `gnus-article-highlight-citation'."
694 total)
700 gnus-cite-prefix-alist))))
719 gnus-hidden-properties)))))))))
723 "Hide cited text in non-root articles."
733 ;;; Internal functions:
736 "Always parse the buffer."
738 ;;Reset parser information.
740 gnus-cite-attribution-alist nil
741 gnus-cite-loose-prefix-alist nil
742 gnus-cite-loose-attribution-alist nil)
745 ;; Parse if not too large.
748 ()
764 ;; Wrap chopped gnus-cite-parse.
775 ;; Parse and connect citation prefixes and attribution lines.
777 ;; Parse current buffer searching for citation prefixes.
785 alist entry start begin end numbers prefix guess-limit)
786 ;; Get all potential prefixes in `alist'.
788 ;; Each line.
792 start end)
794 ;; Ignore standard Supercite attribution prefix.
800 ;; Ignore very long prefixes.
803 ;; Ignore quoted envelope From_.
811 ;; Each prefix.
822 ;; Horrible special case for some Microsoft mailers.
826 ;; Assume this search ends up at the beginning of a line.
839 ;; Need to do 1+ because we're in the bol.
843 ;; We got all the potential prefixes. Now create
844 ;; `gnus-cite-prefix-alist' containing the oldest prefix for each
845 ;; line that appears at least `gnus-cite-minimum-match-count'
846 ;; times. First sort them by length. Longer is older.
855 ;; No lines with this prefix that wasn't also part of
856 ;; a longer prefix.
857 )
859 ;; Too few lines with this prefix. We keep it a bit
860 ;; longer in case it is an exact match for an attribution
861 ;; line, but we don't remove the line from other
862 ;; prefixes.
866 gnus-cite-prefix-alist)
867 ;; Remove articles from other prefixes.
869 current)
878 ;; Parse attributions
884 ;; Check previous line for an attribution leader.
896 t)
898 start t))
903 ;; don't add duplicates
906 end)))
909 gnus-cite-loose-attribution-alist)
913 ;; Connect attributions to citations
915 ;; No citations have been connected to attribution lines yet.
918 ;; Parse current buffer searching for attribution lines.
919 ;; Find exact supercite citations.
926 ;; Find loose supercite citations after attributions.
933 ;; Find loose supercite citations anywhere.
940 ;; Find nested citations after attributions.
944 ;; Find nested citations anywhere.
948 ;; Remove loose prefixes with too few lines.
950 entry)
957 gnus-cite-loose-prefix-alist
959 ;; Find flat attributions.
961 ;; Find any attributions (are we getting desperate yet?).
965 ;; Match all loose attributions and citations (SORT AFTER FUN) .
966 ;;
967 ;; If SORT is `small', the citation with the shortest prefix will be
968 ;; used, if it is `first' the first prefix will be used, if it is
969 ;; `small-if-unique' the shortest prefix will be used if the
970 ;; attribution line does not share its own prefix with other
971 ;; loose attribution lines, otherwise the first prefix will be used.
972 ;;
973 ;; If AFTER is non-nil, only citations after the attribution line
974 ;; will be considered.
975 ;;
976 ;; If FUN is non-nil, it will be called with the arguments (WROTE
977 ;; PREFIX TAG) and expected to return a regular expression. Only
978 ;; citations whose prefix matches the regular expression will be
979 ;; considered.
980 ;;
981 ;; WROTE is the attribution line number.
982 ;; PREFIX is the attribution line prefix.
983 ;; TAG is the Supercite tag on the attribution line.
986 att wrote in prefix tag regexp limit smallest best size)
999 smallest 1000000
1000 best nil)
1002 cite candidate numbers first compare)
1011 regexp
1015 smallest compare))))
1017 ()
1026 current)
1033 ()
1041 ;; Return a list of loose attribution lines prefixed by PREFIX.
1043 att line lines)
1050 lines))
1053 ;; At line NUMBER, ignore PREFIX and add FACE to the rest of the line.
1056 from to overlay)
1067 gnus-cite-overlay-list)
1078 number)
1085 ;; Can't remove 'cite from g-a-wash-types here because
1086 ;; multiple citations may be hidden -jas
1088 gnus-hidden-properties))
1095 gnus-hidden-properties))))
1097 gnus-article-mime-handle-alist))
1101 ;; Return citation prefix for LINE.
1104 entry)
1110 prefix))
1113 "Make the citation variables local to the article buffer."
1115 gnus-cite-overlay-list gnus-cite-prefix-alist
1116 gnus-cite-attribution-alist gnus-cite-loose-prefix-alist
1117 gnus-cite-loose-attribution-alist)))
1122 "Say whether the current line is a cited line."
1128 prefix)
1130 found)))
1133 ;; Highlighting of different citation levels in message-mode.
1134 ;; - message-cite-prefix will be overridden if this is enabled.
1144 "Search for a cited line and set match data accordingly.
1145 Returns nil if there is no such line before LIMIT, t otherwise."
1151 gnus-message-max-citation-depth))
1160 t))
1163 ;; eval-when-compile ;; This breaks in XEmacs
1167 ;; (require 'gnus-cite)
1182 "Toggle `gnus-message-citation-mode' in current buffer.
1183 This buffer local minor mode provides additional font-lock support for
1184 nested citations.
1185 With prefix ARG, turn `gnus-message-citation-mode' on if and only if ARG
1186 is positive.
1187 Automatically turn `font-lock-mode' on when `gnus-message-citation-mode'
1188 is turned on."
1189 nil ;; init-value
1191 nil ;; keymap
1195 font-lock-defaults)))
1196 default keywords)
1201 defaults
1204 ;; `gnus-message-citation-keywords' should be the last
1205 ;; elements of the keywords because the others are unlikely
1206 ;; to have the OVERRIDE flags -- XEmacs applies a keyword
1207 ;; having no OVERRIDE flag to matched text even if it has
1208 ;; already other faces, while Emacs doesn't.
1211 gnus-message-citation-keywords))
1213 ;; Force `font-lock-set-defaults' to update `font-lock-keywords'.
1218 font-lock-keywords nil))
1227 "Turn on `gnus-message-citation-mode'."
1230 "Turn off `gnus-message-citation-mode'."
1237 ;; Local Variables:
1238 ;; coding: iso-8859-1
1239 ;; End:
1241 ;;; arch-tag: 1997b044-6067-471e-8c8f-dc903093098a
1242 ;;; gnus-cite.el ends here