| blob | 758a0ecbe2aeb93455eb767ec887c0e5157ed7b3 |
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:
36 ;;; Customization:
39 "Citation."
45 "Format of opened cited text buttons."
50 "Format of closed cited text buttons."
55 "The number of lines of hidden cited text to remain visible.
56 Or a pair (cons) of numbers which are the number of lines at the top
57 and bottom of the text, respectively, to remain visible."
60 integer
64 "Maximum article size (in bytes) where parsing citations is allowed.
65 Set it to nil to parse all articles."
68 integer))
71 "Maximum possible length for a citation prefix."
78 "*Regexp matching normal Supercite attribution lines.
79 The first grouping must match prefixes added by other packages."
84 "Regexp matching mangled Supercite attribution lines.
85 The first regexp group should match the Supercite attribution."
90 "Minimum number of identical prefixes before we believe it's a citation."
94 ;; Some Microsoft products put in a citation that extends to the
95 ;; remainder of the message:
96 ;;
97 ;; -----Original Message-----
98 ;; From: ...
99 ;; To: ...
100 ;; Sent: ... [date, in non-RFC-2822 format]
101 ;; Subject: ...
102 ;;
103 ;; Cited message, with no prefixes
104 ;;
105 ;; The four headers are always the same. But note they are prone to
106 ;; folding without additional indentation.
107 ;;
108 ;; Others use "----- Original Message -----" instead, and properly quote
109 ;; the body using "> ". This style is handled without special cases.
112 "In article\\|in <\\|On \\(Mon\\|Tue\\|Wed\\|Thu\\|Fri\\|Sat\\|Sun\\),\\|----- ?Original Message ?-----"
113 "*Regexp matching the beginning of an attribution line."
118 "\\(\\(wrote\\|writes\\|said\\|says\\|>\\)\\(:\\|\\.\\.\\.\\)\\|----- ?Original Message ?-----\\)[ \t]*$"
119 "*Regexp matching the end of an attribution line.
120 The text matching the first grouping will be used as a button."
126 "Regexp matching Microsoft-type rest-of-message citations."
133 Those lines may have been quoted by MTAs in order not to mix up with
134 the envelope From line."
140 "Face used for attribution lines."
142 ;; backward-compatibility alias
146 "Face used for attribution lines.
147 It is merged with the face for the cited text belonging to the attribution."
160 "Citation face."
162 ;; backward-compatibility alias
173 "Citation face."
175 ;; backward-compatibility alias
186 "Citation face."
188 ;; backward-compatibility alias
199 "Citation face."
201 ;; backward-compatibility alias
212 "Citation face."
214 ;; backward-compatibility alias
225 "Citation face."
227 ;; backward-compatibility alias
238 "Citation face."
240 ;; backward-compatibility alias
251 "Citation face."
253 ;; backward-compatibility alias
264 "Citation face."
266 ;; backward-compatibility alias
277 "Citation face."
279 ;; backward-compatibility alias
290 "Citation face."
292 ;; backward-compatibility alias
297 gnus-cite-7 gnus-cite-8 gnus-cite-9 gnus-cite-10 gnus-cite-11)
298 "*List of faces used for highlighting citations.
300 When there are citations from multiple articles in the same message,
301 Gnus will try to give each citation from each article its own face.
302 This should make it easier to see who wrote what."
307 "Only hide excess citation if above this percentage of the body."
312 "Only hide excess citation if above this number of lines in the body."
317 "If non-nil, put a blank line between the citation header and the button."
321 ;; This has to go here because its default value depends on
322 ;; gnus-cite-face-list.
324 "List of faces that are not worth reading.
325 If an article has more pages below the one you are looking at, but
326 nothing on those pages is a word of at least three letters that is not
327 in a boring face, then the pages will be skipped."
331 ;;; Internal Variables:
337 ;; Alist of citation prefixes.
338 ;; The cdr is a list of lines with that prefix.
341 ;; Alist of attribution lines.
342 ;; The car is a line number.
343 ;; The cdr is the prefix for the citation started by that line.
346 ;; Alist of citation prefixes that have no matching attribution.
347 ;; The cdr is a list of lines with that prefix.
350 ;; Alist of attribution lines that have no matching citation.
351 ;; Each member has the form (WROTE IN PREFIX TAG), where
352 ;; WROTE: is the attribution line number
353 ;; IN: is the line number of the previous line if part of the same attribution,
354 ;; PREFIX: Is the citation prefix of the attribution line(s), and
355 ;; TAG: Is a Supercite tag, if any.
364 gnus-cited-opened-text-button-line-format-alist)
368 ;;; Commands:
371 "Highlight cited text.
372 Each citation in the article will be highlighted with a different face.
373 The faces are taken from `gnus-cite-face-list'.
374 Attribution lines are highlighted with the same face as the
375 corresponding citation merged with the face `gnus-cite-attribution'.
377 Text is considered cited if at least `gnus-cite-minimum-match-count'
378 lines matches `message-cite-prefix-regexp' with the same prefix.
380 Lines matching `gnus-cite-attribution-suffix' and perhaps
381 `gnus-cite-attribution-prefix' are considered attribution lines."
390 face entry prefix skip numbers number face-alist)
391 ;; Loop through citation prefixes.
406 ;; Loop through attribution lines.
415 ;; Add attribution button.
420 t)
423 ;; Highlight attribution line.
426 ;; Loop through attribution lines.
436 "Dissect the article buffer looking for cited text."
441 prefix numbers number marks m)
442 ;; Loop through citation prefixes.
457 ;; Skip to the beginning of the body.
460 ;; Find the end of the body.
464 ;; Sort the marks.
492 marks))))
495 "Do word wrapping in the current article.
496 If WIDTH (the numerical prefix), use that text width when filling."
514 use-hard-newlines)
520 ;; All this information is now incorrect.
522 gnus-cite-attribution-alist nil
523 gnus-cite-loose-prefix-alist nil
524 gnus-cite-loose-attribution-alist nil
525 gnus-cite-article nil)))))
528 "Toggle hiding of all cited text except attribution lines.
529 See the documentation for `gnus-article-highlight-citation'.
530 If given a negative prefix, always show; if given a positive prefix,
531 always hide."
538 marks
541 gnus-hidden-properties))
543 found beg end start)
546 'gnus-callback
558 end nil)
567 ;; Skip past lines we want to leave visible.
572 gnus-cited-lines-visible))
584 ;; We use markers for the end-points to facilitate later
585 ;; wrapping and mangling of text.
600 `gnus-article-toggle-cited-text
607 "Toggle hiding the text in REGION.
608 ARG can be nil or a number. Positive means hide, negative
609 means show, nil means toggle."
617 buffer-read-only)
624 ;; Can't remove 'cite from g-a-wash-types here because
625 ;; multiple citations may be hidden -jas
629 gnus-hidden-properties))))
632 'article-type nil beg end
634 gnus-hidden-properties))))
647 gnus-cited-opened-text-button-line-format-spec
648 gnus-cited-closed-text-button-line-format-spec))
650 `gnus-article-toggle-cited-text
651 args)
656 "Toggle hiding of cited text that has an attribution line.
657 If given a negative prefix, always show; if given a positive prefix,
658 always hide.
659 This will do nothing unless at least `gnus-cite-hide-percentage'
660 percent and at least `gnus-cite-hide-absolute' lines of the body is
661 cited text with attributions. When called interactively, these two
662 variables are ignored.
663 See also the documentation for `gnus-article-highlight-citation'."
676 total)
682 gnus-cite-prefix-alist))))
701 gnus-hidden-properties)))))))))
705 "Hide cited text in non-root articles."
715 ;;; Internal functions:
718 "Always parse the buffer."
720 ;;Reset parser information.
722 gnus-cite-attribution-alist nil
723 gnus-cite-loose-prefix-alist nil
724 gnus-cite-loose-attribution-alist nil)
727 ;; Parse if not too large.
730 ()
746 ;; Wrap chopped gnus-cite-parse.
757 ;; Parse and connect citation prefixes and attribution lines.
759 ;; Parse current buffer searching for citation prefixes.
767 alist entry start begin end numbers prefix guess-limit)
768 ;; Get all potential prefixes in `alist'.
770 ;; Each line.
774 start end)
776 ;; Ignore standard Supercite attribution prefix.
782 ;; Ignore very long prefixes.
785 ;; Ignore quoted envelope From_.
793 ;; Each prefix.
804 ;; Horrible special case for some Microsoft mailers.
814 ;; We got all the potential prefixes. Now create
815 ;; `gnus-cite-prefix-alist' containing the oldest prefix for each
816 ;; line that appears at least `gnus-cite-minimum-match-count'
817 ;; times. First sort them by length. Longer is older.
826 ;; No lines with this prefix that wasn't also part of
827 ;; a longer prefix.
828 )
830 ;; Too few lines with this prefix. We keep it a bit
831 ;; longer in case it is an exact match for an attribution
832 ;; line, but we don't remove the line from other
833 ;; prefixes.
837 gnus-cite-prefix-alist)
838 ;; Remove articles from other prefixes.
840 current)
849 ;; Parse attributions
855 ;; Check previous line for an attribution leader.
867 t)
869 start t))
874 ;; don't add duplicates
877 end)))
881 gnus-cite-loose-attribution-alist)
885 ;; Connect attributions to citations
887 ;; No citations have been connected to attribution lines yet.
890 ;; Parse current buffer searching for attribution lines.
891 ;; Find exact supercite citations.
898 ;; Find loose supercite citations after attributions.
905 ;; Find loose supercite citations anywhere.
912 ;; Find nested citations after attributions.
916 ;; Find nested citations anywhere.
920 ;; Remove loose prefixes with too few lines.
922 entry)
929 gnus-cite-loose-prefix-alist
931 ;; Find flat attributions.
933 ;; Find any attributions (are we getting desperate yet?).
937 ;; Match all loose attributions and citations (SORT AFTER FUN) .
938 ;;
939 ;; If SORT is `small', the citation with the shortest prefix will be
940 ;; used, if it is `first' the first prefix will be used, if it is
941 ;; `small-if-unique' the shortest prefix will be used if the
942 ;; attribution line does not share its own prefix with other
943 ;; loose attribution lines, otherwise the first prefix will be used.
944 ;;
945 ;; If AFTER is non-nil, only citations after the attribution line
946 ;; will be considered.
947 ;;
948 ;; If FUN is non-nil, it will be called with the arguments (WROTE
949 ;; PREFIX TAG) and expected to return a regular expression. Only
950 ;; citations whose prefix matches the regular expression will be
951 ;; considered.
952 ;;
953 ;; WROTE is the attribution line number.
954 ;; PREFIX is the attribution line prefix.
955 ;; TAG is the Supercite tag on the attribution line.
958 att wrote in prefix tag regexp limit smallest best size)
971 smallest 1000000
972 best nil)
974 cite candidate numbers first compare)
983 regexp
987 smallest compare))))
989 ()
998 current)
1005 ()
1013 ;; Return a list of loose attribution lines prefixed by PREFIX.
1015 att line lines)
1022 lines))
1025 ;; At line NUMBER, ignore PREFIX and add FACE to the rest of the line.
1028 from to overlay)
1039 gnus-cite-overlay-list)
1050 number)
1057 ;; Can't remove 'cite from g-a-wash-types here because
1058 ;; multiple citations may be hidden -jas
1060 gnus-hidden-properties))
1067 gnus-hidden-properties))))
1069 gnus-article-mime-handle-alist))
1073 ;; Return citation prefix for LINE.
1076 entry)
1082 prefix))
1085 "Make the citation variables local to the article buffer."
1087 gnus-cite-overlay-list gnus-cite-prefix-alist
1088 gnus-cite-attribution-alist gnus-cite-loose-prefix-alist
1089 gnus-cite-loose-attribution-alist)))
1094 "Say whether the current line is a cited line."
1100 prefix)
1102 found)))
1108 ;; Local Variables:
1109 ;; coding: iso-8859-1
1110 ;; End:
1112 ;;; arch-tag: 1997b044-6067-471e-8c8f-dc903093098a
1113 ;;; gnus-cite.el ends here