cgit.sxemacs.org Git - gnus/blob - lisp/gnus-cite.el

   1 ;;; gnus-cite.el --- parse citations in articles for Gnus
   2 ;; Copyright (C) 1995,96,97,98,99 Free Software Foundation, Inc.
   3
   4 ;; Author: Per Abhiddenware; you can redistribute it and/or modify
   5 ;; it under the terms of the GNU General Public License as published by
   6 ;; the Free Software Foundation; either version 2, or (at your option)
   7 ;; any later version.
   8
   9 ;; GNU Emacs is distributed in the hope that it will be useful,
  10 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 ;; GNU General Public License for more details.
  13
  14 ;; You should have received a copy of the GNU General Public License
  15 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  16 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17 ;; Boston, MA 02111-1307, USA.
  18
  19 ;;; Commentary:
  20
  21 ;;; Code:
  22
  23 (eval-when-compile (require 'cl))
  24
  25 (require 'gnus)
  26 (require 'gnus-art)
  27 (require 'gnus-range)
  28
  29 ;;; Customization:
  30
  31 (defgroup gnus-cite nil
  32   "Citation."
  33   :prefix "gnus-cite-"
  34   :link '(custom-manual "(gnus)Article Highlighting")
  35   :group 'gnus-article)
  36
  37 (defcustom gnus-cite-reply-regexp
  38   "^\\(Subject: Re\\|In-Reply-To\\|References\\):"
  39   "*If headers match this regexp it is reasonable to believe that
  40 article has citations."
  41   :group 'gnus-cite
  42   :type 'string)
  43
  44 (defcustom gnus-cite-always-check nil
  45   "Check article always for citations. Set it t to check all articles."
  46   :group 'gnus-cite
  47   :type '(choice (const :tag "no" nil)
  48                   (const :tag "yes" t)))
  49
  50 (defcustom gnus-cited-opened-text-button-line-format "%(%{[-]%}%)\n"
  51   "Format of opened cited text buttons."
  52   :group 'gnus-cite
  53   :type 'string)
  54
  55 (defcustom gnus-cited-closed-text-button-line-format "%(%{[+]%}%)\n"
  56   "Format of closed cited text buttons."
  57   :group 'gnus-cite
  58   :type 'string)
  59
  60 (defcustom gnus-cited-lines-visible nil
  61   "The number of lines of hidden cited text to remain visible.
  62 Or a pair (cons) of numbers which are the number of lines at the top
  63 and bottom of the text, respectively, to remain visible."
  64   :group 'gnus-cite
  65   :type '(choice (const :tag "none" nil)
  66                  integer
  67                  (cons :tag "Top and Bottom" integer integer)))
  68
  69 (defcustom gnus-cite-parse-max-size 25000
  70   "Maximum article size (in bytes) where parsing citations is allowed.
  71 Set it to nil to parse all articles."
  72   :group 'gnus-cite
  73   :type '(choice (const :tag "all" nil)
  74                  integer))
  75
  76 (defcustom gnus-cite-prefix-regexp
  77   "^[]>»|:}+ ]*[]>»|:}+]\\(.*>»\\)?\\|^.*>"
  78   "*Regexp matching the longest possible citation prefix on a line."
  79   :group 'gnus-cite
  80   :type 'regexp)
  81
  82 (defcustom gnus-cite-max-prefix 20
  83   "Maximum possible length for a citation prefix."
  84   :group 'gnus-cite
  85   :type 'integer)
  86
  87 (defcustom gnus-supercite-regexp
  88   (concat "^\\(" gnus-cite-prefix-regexp "\\)? *"
  89           ">>>>> +\"\\([^\"\n]+\\)\" +==")
  90   "*Regexp matching normal Supercite attribution lines.
  91 The first grouping must match prefixes added by other packages."
  92   :group 'gnus-cite
  93   :type 'regexp)
  94
  95 (defcustom gnus-supercite-secondary-regexp "^.*\"\\([^\"\n]+\\)\" +=="
  96   "Regexp matching mangled Supercite attribution lines.
  97 The first regexp group should match the Supercite attribution."
  98   :group 'gnus-cite
  99   :type 'regexp)
 100
 101 (defcustom gnus-cite-minimum-match-count 2
 102   "Minimum number of identical prefixes before we believe it's a citation."
 103   :group 'gnus-cite
 104   :type 'integer)
 105
 106 (defcustom gnus-cite-attribution-prefix
 107   "In article\\|in <\\|On \\(Mon\\|Tue\\|Wed\\|Thu\\|Fri\\|Sat\\|Sun\\),\\|    > -----Original Message-----"
 108   "*Regexp matching the beginning of an attribution line."
 109   :group 'gnus-cite
 110   :type 'regexp)
 111
 112 (defcustom gnus-cite-attribution-suffix
 113   "\\(\\(wrote\\|writes\\|said\\|says\\|>\\)\\(:\\|\\.\\.\\.\\)\\|-----Original Message-----\\)[ \t]*$"
 114   "*Regexp matching the end of an attribution line.
 115 The text matching the first grouping will be used as a button."
 116   :group 'gnus-cite
 117   :type 'regexp)
 118
 119 (defface gnus-cite-attribution-face '((t
 120                                        (:italic t)))
 121   "Face used for attribution lines.")
 122
 123 (defcustom gnus-cite-attribution-face 'gnus-cite-attribution-face
 124   "Face used for attribution lines.
 125 It is merged with the face for the cited text belonging to the attribution."
 126   :group 'gnus-cite
 127   :type 'face)
 128
 129 (defface gnus-cite-face-1 '((((class color)
 130                               (background dark))
 131                              (:foreground "light blue"))
 132                             (((class color)
 133                               (background light))
 134                              (:foreground "MidnightBlue"))
 135                             (t
 136                              (:italic t)))
 137   "Citation face.")
 138
 139 (defface gnus-cite-face-2 '((((class color)
 140                               (background dark))
 141                              (:foreground "light cyan"))
 142                             (((class color)
 143                               (background light))
 144                              (:foreground "firebrick"))
 145                             (t
 146                              (:italic t)))
 147   "Citation face.")
 148
 149 (defface gnus-cite-face-3 '((((class color)
 150                               (background dark))
 151                              (:foreground "light yellow"))
 152                             (((class color)
 153                               (background light))
 154                              (:foreground "dark green"))
 155                             (t
 156                              (:italic t)))
 157   "Citation face.")
 158
 159 (defface gnus-cite-face-4 '((((class color)
 160                               (background dark))
 161                              (:foreground "light pink"))
 162                             (((class color)
 163                               (background light))
 164                              (:foreground "OrangeRed"))
 165                             (t
 166                              (:italic t)))
 167   "Citation face.")
 168
 169 (defface gnus-cite-face-5 '((((class color)
 170                               (background dark))
 171                              (:foreground "pale green"))
 172                             (((class color)
 173                               (background light))
 174                              (:foreground "dark khaki"))
 175                             (t
 176                              (:italic t)))
 177   "Citation face.")
 178
 179 (defface gnus-cite-face-6 '((((class color)
 180                               (background dark))
 181                              (:foreground "beige"))
 182                             (((class color)
 183                               (background light))
 184                              (:foreground "dark violet"))
 185                             (t
 186                              (:italic t)))
 187   "Citation face.")
 188
 189 (defface gnus-cite-face-7 '((((class color)
 190                               (background dark))
 191                              (:foreground "orange"))
 192                             (((class color)
 193                               (background light))
 194                              (:foreground "SteelBlue4"))
 195                             (t
 196                              (:italic t)))
 197   "Citation face.")
 198
 199 (defface gnus-cite-face-8 '((((class color)
 200                               (background dark))
 201                              (:foreground "magenta"))
 202                             (((class color)
 203                               (background light))
 204                              (:foreground "magenta"))
 205                             (t
 206                              (:italic t)))
 207   "Citation face.")
 208
 209 (defface gnus-cite-face-9 '((((class color)
 210                               (background dark))
 211                              (:foreground "violet"))
 212                             (((class color)
 213                               (background light))
 214                              (:foreground "violet"))
 215                             (t
 216                              (:italic t)))
 217   "Citation face.")
 218
 219 (defface gnus-cite-face-10 '((((class color)
 220                                (background dark))
 221                               (:foreground "medium purple"))
 222                              (((class color)
 223                                (background light))
 224                               (:foreground "medium purple"))
 225                              (t
 226                               (:italic t)))
 227   "Citation face.")
 228
 229 (defface gnus-cite-face-11 '((((class color)
 230                                (background dark))
 231                               (:foreground "turquoise"))
 232                              (((class color)
 233                                (background light))
 234                               (:foreground "turquoise"))
 235                              (t
 236                               (:italic t)))
 237   "Citation face.")
 238
 239 (defcustom gnus-cite-face-list
 240   '(gnus-cite-face-1 gnus-cite-face-2 gnus-cite-face-3 gnus-cite-face-4
 241     gnus-cite-face-5 gnus-cite-face-6 gnus-cite-face-7 gnus-cite-face-8
 242     gnus-cite-face-9 gnus-cite-face-10 gnus-cite-face-11)
 243   "*List of faces used for highlighting citations.
 244
 245 When there are citations from multiple articles in the same message,
 246 Gnus will try to give each citation from each article its own face.
 247 This should make it easier to see who wrote what."
 248   :group 'gnus-cite
 249   :type '(repeat face))
 250
 251 (defcustom gnus-cite-hide-percentage 50
 252   "Only hide excess citation if above this percentage of the body."
 253   :group 'gnus-cite
 254   :type 'number)
 255
 256 (defcustom gnus-cite-hide-absolute 10
 257   "Only hide excess citation if above this number of lines in the body."
 258   :group 'gnus-cite
 259   :type 'integer)
 260
 261 ;;; Internal Variables:
 262
 263 (defvar gnus-cite-article nil)
 264 (defvar gnus-cite-overlay-list nil)
 265
 266 (defvar gnus-cite-prefix-alist nil)
 267 ;; Alist of citation prefixes.
 268 ;; The cdr is a list of lines with that prefix.
 269
 270 (defvar gnus-cite-attribution-alist nil)
 271 ;; Alist of attribution lines.
 272 ;; The car is a line number.
 273 ;; The cdr is the prefix for the citation started by that line.
 274
 275 (defvar gnus-cite-loose-prefix-alist nil)
 276 ;; Alist of citation prefixes that have no matching attribution.
 277 ;; The cdr is a list of lines with that prefix.
 278
 279 (defvar gnus-cite-loose-attribution-alist nil)
 280 ;; Alist of attribution lines that have no matching citation.
 281 ;; Each member has the form (WROTE IN PREFIX TAG), where
 282 ;; WROTE: is the attribution line number
 283 ;; IN: is the line number of the previous line if part of the same attribution,
 284 ;; PREFIX: Is the citation prefix of the attribution line(s), and
 285 ;; TAG: Is a Supercite tag, if any.
 286
 287 (defvar gnus-cited-opened-text-button-line-format-alist
 288   `((?b (marker-position beg) ?d)
 289     (?e (marker-position end) ?d)
 290     (?n (count-lines beg end) ?d)
 291     (?l (- end beg) ?d)))
 292 (defvar gnus-cited-opened-text-button-line-format-spec nil)
 293 (defvar gnus-cited-closed-text-button-line-format-alist
 294   gnus-cited-opened-text-button-line-format-alist)
 295 (defvar gnus-cited-closed-text-button-line-format-spec nil)
 296
 297
 298 ;;; Commands:
 299
 300 (defun gnus-article-highlight-citation (&optional force)
 301   "Highlight cited text.
 302 Each citation in the article will be highlighted with a different face.
 303 The faces are taken from `gnus-cite-face-list'.
 304 Attribution lines are highlighted with the same face as the
 305 corresponding citation merged with `gnus-cite-attribution-face'.
 306
 307 Text is considered cited if at least `gnus-cite-minimum-match-count'
 308 lines matches `gnus-cite-prefix-regexp' with the same prefix.
 309
 310 Lines matching `gnus-cite-attribution-suffix' and perhaps
 311 `gnus-cite-attribution-prefix' are considered attribution lines."
 312   (interactive (list 'force))
 313   (save-excursion
 314     (set-buffer gnus-article-buffer)
 315     (gnus-cite-parse-maybe force)
 316     (let ((buffer-read-only nil)
 317           (alist gnus-cite-prefix-alist)
 318           (faces gnus-cite-face-list)
 319           (inhibit-point-motion-hooks t)
 320           face entry prefix skip numbers number face-alist)
 321       ;; Loop through citation prefixes.
 322       (while alist
 323         (setq entry (car alist)
 324               alist (cdr alist)
 325               prefix (car entry)
 326               numbers (cdr entry)
 327               face (car faces)
 328               faces (or (cdr faces) gnus-cite-face-list)
 329               face-alist (cons (cons prefix face) face-alist))
 330         (while numbers
 331           (setq number (car numbers)
 332                 numbers (cdr numbers))
 333           (and (not (assq number gnus-cite-attribution-alist))
 334                (not (assq number gnus-cite-loose-attribution-alist))
 335                (gnus-cite-add-face number prefix face))))
 336       ;; Loop through attribution lines.
 337       (setq alist gnus-cite-attribution-alist)
 338       (while alist
 339         (setq entry (car alist)
 340               alist (cdr alist)
 341               number (car entry)
 342               prefix (cdr entry)
 343               skip (gnus-cite-find-prefix number)
 344               face (cdr (assoc prefix face-alist)))
 345         ;; Add attribution button.
 346         (goto-char (point-min))
 347         (forward-line (1- number))
 348         (when (re-search-forward gnus-cite-attribution-suffix
 349                                  (save-excursion (end-of-line 1) (point))
 350                                  t)
 351           (gnus-article-add-button (match-beginning 1) (match-end 1)
 352                                    'gnus-cite-toggle prefix))
 353         ;; Highlight attribution line.
 354         (gnus-cite-add-face number skip face)
 355         (gnus-cite-add-face number skip gnus-cite-attribution-face))
 356       ;; Loop through attribution lines.
 357       (setq alist gnus-cite-loose-attribution-alist)
 358       (while alist
 359         (setq entry (car alist)
 360               alist (cdr alist)
 361               number (car entry)
 362               skip (gnus-cite-find-prefix number))
 363         (gnus-cite-add-face number skip gnus-cite-attribution-face)))))
 364
 365 (defun gnus-dissect-cited-text ()
 366   "Dissect the article buffer looking for cited text."
 367   (save-excursion
 368     (set-buffer gnus-article-buffer)
 369     (gnus-cite-parse-maybe nil t)
 370     (let ((alist gnus-cite-prefix-alist)
 371           prefix numbers number marks m)
 372       ;; Loop through citation prefixes.
 373       (while alist
 374         (setq numbers (pop alist)
 375               prefix (pop numbers))
 376         (while numbers
 377           (setq number (pop numbers))
 378           (goto-char (point-min))
 379           (forward-line number)
 380           (push (cons (point-marker) "") marks)
 381           (while (and numbers
 382                       (= (1- number) (car numbers)))
 383             (setq number (pop numbers)))
 384           (goto-char (point-min))
 385           (forward-line (1- number))
 386           (push (cons (point-marker) prefix) marks)))
 387       ;; Skip to the beginning of the body.
 388       (article-goto-body)
 389       (push (cons (point-marker) "") marks)
 390       ;; Find the end of the body.
 391       (goto-char (point-max))
 392       (gnus-article-search-signature)
 393       (push (cons (point-marker) "") marks)
 394       ;; Sort the marks.
 395       (setq marks (sort marks 'car-less-than-car))
 396       (let ((omarks marks))
 397         (setq marks nil)
 398         (while (cdr omarks)
 399           (if (= (caar omarks) (caadr omarks))
 400               (progn
 401                 (unless (equal (cdar omarks) "")
 402                   (push (car omarks) marks))
 403                 (unless (equal (cdadr omarks) "")
 404                   (push (cadr omarks) marks))
 405                 (unless (and (equal (cdar omarks) "")
 406                              (equal (cdadr omarks) "")
 407                              (not (cddr omarks)))
 408                   (setq omarks (cdr omarks))))
 409             (push (car omarks) marks))
 410           (setq omarks (cdr omarks)))
 411         (when (car omarks)
 412           (push (car omarks) marks))
 413         (setq marks (setq m (nreverse marks)))
 414         (while (cddr m)
 415           (if (and (equal (cdadr m) "")
 416                    (equal (cdar m) (cdaddr m))
 417                    (goto-char (caadr m))
 418                    (forward-line 1)
 419                    (= (point) (caaddr m)))
 420               (setcdr m (cdddr m))
 421             (setq m (cdr m))))
 422         marks))))
 423
 424 (defun gnus-article-fill-cited-article (&optional force width)
 425   "Do word wrapping in the current article.
 426 If WIDTH (the numerical prefix), use that text width when filling."
 427   (interactive (list t current-prefix-arg))
 428   (save-excursion
 429     (set-buffer gnus-article-buffer)
 430     (let ((buffer-read-only nil)
 431           (inhibit-point-motion-hooks t)
 432           (marks (gnus-dissect-cited-text))
 433           (adaptive-fill-mode nil)
 434           (filladapt-mode nil)
 435           (fill-column (if width (prefix-numeric-value width) fill-column)))
 436       (save-restriction
 437         (while (cdr marks)
 438           (narrow-to-region (caar marks) (caadr marks))
 439           (let ((adaptive-fill-regexp
 440                  (concat "^" (regexp-quote (cdar marks)) " *"))
 441                 (fill-prefix (cdar marks)))
 442             (fill-region (point-min) (point-max)))
 443           (set-marker (caar marks) nil)
 444           (setq marks (cdr marks)))
 445         (when marks
 446           (set-marker (caar marks) nil))
 447         ;; All this information is now incorrect.
 448         (setq gnus-cite-prefix-alist nil
 449               gnus-cite-attribution-alist nil
 450               gnus-cite-loose-prefix-alist nil
 451               gnus-cite-loose-attribution-alist nil
 452               gnus-cite-article nil)))))
 453
 454 (defun gnus-article-hide-citation (&optional arg force)
 455   "Toggle hiding of all cited text except attribution lines.
 456 See the documentation for `gnus-article-highlight-citation'.
 457 If given a negative prefix, always show; if given a positive prefix,
 458 always hide."
 459   (interactive (append (gnus-article-hidden-arg) (list 'force)))
 460   (gnus-set-format 'cited-opened-text-button t)
 461   (gnus-set-format 'cited-closed-text-button t)
 462   (save-excursion
 463     (set-buffer gnus-article-buffer)
 464     (cond
 465      ((gnus-article-check-hidden-text 'cite arg)
 466       t)
 467      ((gnus-article-text-type-exists-p 'cite)
 468       (let ((buffer-read-only nil))
 469         (gnus-article-hide-text-of-type 'cite)))
 470      (t
 471       (let ((buffer-read-only nil)
 472             (marks (gnus-dissect-cited-text))
 473             (inhibit-point-motion-hooks t)
 474             (props (nconc (list 'article-type 'cite)
 475                           gnus-hidden-properties))
 476             beg end start)
 477         (while marks
 478           (setq beg nil
 479                 end nil)
 480           (while (and marks (string= (cdar marks) ""))
 481             (setq marks (cdr marks)))
 482           (when marks
 483             (setq beg (caar marks)))
 484           (while (and marks (not (string= (cdar marks) "")))
 485             (setq marks (cdr marks)))
 486           (when marks
 487             (setq end (caar marks)))
 488           ;; Skip past lines we want to leave visible.
 489           (when (and beg end gnus-cited-lines-visible)
 490             (goto-char beg)
 491             (forward-line (if (consp gnus-cited-lines-visible)
 492                               (car gnus-cited-lines-visible)
 493                             gnus-cited-lines-visible))
 494             (if (>= (point) end)
 495                 (setq beg nil)
 496               (setq beg (point-marker))
 497               (when (consp gnus-cited-lines-visible)
 498                 (goto-char end)
 499                 (forward-line (- (cdr gnus-cited-lines-visible)))
 500                 (if (<= (point) beg)
 501                     (setq beg nil)
 502                   (setq end (point-marker))))))
 503           (when (and beg end)
 504             ;; We use markers for the end-points to facilitate later
 505             ;; wrapping and mangling of text.
 506             (setq beg (set-marker (make-marker) beg)
 507                   end (set-marker (make-marker) end))
 508             (gnus-add-text-properties beg end props)
 509             (goto-char beg)
 510             (unless (save-excursion (search-backward "\n\n" nil t))
 511               (insert "\n"))
 512             (put-text-property
 513              (setq start (point-marker))
 514              (progn
 515                (gnus-article-add-button
 516                 (point)
 517                 (progn (eval gnus-cited-closed-text-button-line-format-spec)
 518                        (point))
 519                 `gnus-article-toggle-cited-text
 520                 (list (cons beg end) start))
 521                (point))
 522              'article-type 'annotation)
 523             (set-marker beg (point)))))))))
 524
 525 (defun gnus-article-toggle-cited-text (args)
 526   "Toggle hiding the text in REGION."
 527   (let* ((region (car args))
 528          (start (cadr args))
 529          (hidden
 530           (text-property-any
 531            (car region) (1- (cdr region))
 532            (car gnus-hidden-properties) (cadr gnus-hidden-properties)))
 533          (inhibit-point-motion-hooks t)
 534          buffer-read-only)
 535     (funcall
 536      (if hidden
 537          'remove-text-properties 'gnus-add-text-properties)
 538      (car region) (cdr region) gnus-hidden-properties)
 539     (save-excursion
 540       (goto-char start)
 541       (gnus-delete-line)
 542       (put-text-property
 543        (point)
 544        (progn
 545          (gnus-article-add-button
 546           (point)
 547           (progn (eval
 548                   (if hidden
 549                       gnus-cited-opened-text-button-line-format-spec
 550                     gnus-cited-closed-text-button-line-format-spec))
 551                  (point))
 552           `gnus-article-toggle-cited-text
 553           args)
 554          (point))
 555        'article-type 'annotation))))
 556
 557 (defun gnus-article-hide-citation-maybe (&optional arg force)
 558   "Toggle hiding of cited text that has an attribution line.
 559 If given a negative prefix, always show; if given a positive prefix,
 560 always hide.
 561 This will do nothing unless at least `gnus-cite-hide-percentage'
 562 percent and at least `gnus-cite-hide-absolute' lines of the body is
 563 cited text with attributions.  When called interactively, these two
 564 variables are ignored.
 565 See also the documentation for `gnus-article-highlight-citation'."
 566   (interactive (append (gnus-article-hidden-arg) '(force)))
 567   (unless (gnus-article-check-hidden-text 'cite arg)
 568     (save-excursion
 569       (set-buffer gnus-article-buffer)
 570       (gnus-cite-parse-maybe force)
 571       (article-goto-body)
 572       (let ((start (point))
 573             (atts gnus-cite-attribution-alist)
 574             (buffer-read-only nil)
 575             (inhibit-point-motion-hooks t)
 576             (hidden 0)
 577             total)
 578         (goto-char (point-max))
 579         (gnus-article-search-signature)
 580         (setq total (count-lines start (point)))
 581         (while atts
 582           (setq hidden (+ hidden (length (cdr (assoc (cdar atts)
 583                                                      gnus-cite-prefix-alist))))
 584                 atts (cdr atts)))
 585         (when (or force
 586                   (and (> (* 100 hidden) (* gnus-cite-hide-percentage total))
 587                        (> hidden gnus-cite-hide-absolute)))
 588           (setq atts gnus-cite-attribution-alist)
 589           (while atts
 590             (setq total (cdr (assoc (cdar atts) gnus-cite-prefix-alist))
 591                   atts (cdr atts))
 592             (while total
 593               (setq hidden (car total)
 594                     total (cdr total))
 595               (goto-char (point-min))
 596               (forward-line (1- hidden))
 597               (unless (assq hidden gnus-cite-attribution-alist)
 598                 (gnus-add-text-properties
 599                  (point) (progn (forward-line 1) (point))
 600                  (nconc (list 'article-type 'cite)
 601                         gnus-hidden-properties))))))))))
 602
 603 (defun gnus-article-hide-citation-in-followups ()
 604   "Hide cited text in non-root articles."
 605   (interactive)
 606   (save-excursion
 607     (set-buffer gnus-article-buffer)
 608     (let ((article (cdr gnus-article-current)))
 609       (unless (save-excursion
 610                 (set-buffer gnus-summary-buffer)
 611                 (gnus-article-displayed-root-p article))
 612         (gnus-article-hide-citation)))))
 613
 614 ;;; Internal functions:
 615
 616 (defun gnus-cite-parse-maybe (&optional force no-overlay)
 617   "Always parse the buffer."
 618   (gnus-cite-localize)
 619   ;;Reset parser information.
 620   (setq gnus-cite-prefix-alist nil
 621         gnus-cite-attribution-alist nil
 622         gnus-cite-loose-prefix-alist nil
 623         gnus-cite-loose-attribution-alist nil)
 624   (unless no-overlay
 625     (gnus-cite-delete-overlays))
 626   ;; Parse if not too large.
 627   (if (and gnus-cite-parse-max-size
 628            (> (buffer-size) gnus-cite-parse-max-size))
 629       ()
 630     (setq gnus-cite-article (cons (car gnus-article-current)
 631                                   (cdr gnus-article-current)))
 632     (gnus-cite-parse-wrapper)))
 633
 634 (defun gnus-cite-delete-overlays ()
 635   (dolist (overlay gnus-cite-overlay-list)
 636     (when (or (not (gnus-overlay-end overlay))
 637               (and (>= (gnus-overlay-end overlay) (point-min))
 638                    (<= (gnus-overlay-end overlay) (point-max))))
 639       (setq gnus-cite-overlay-list (delete overlay gnus-cite-overlay-list))
 640       (gnus-delete-overlay overlay))))
 641
 642 (defun gnus-cite-parse-wrapper ()
 643   ;; Wrap chopped gnus-cite-parse.
 644   (article-goto-body)
 645   (let ((inhibit-point-motion-hooks t))
 646     (save-excursion
 647       (gnus-cite-parse-attributions))
 648     (save-excursion
 649       (gnus-cite-parse))
 650     (save-excursion
 651       (gnus-cite-connect-attributions))))
 652
 653 (defun gnus-cite-parse ()
 654   ;; Parse and connect citation prefixes and attribution lines.
 655
 656   ;; Parse current buffer searching for citation prefixes.
 657   (let ((line (1+ (count-lines (point-min) (point))))
 658         (case-fold-search t)
 659         (max (save-excursion
 660                (goto-char (point-max))
 661                (gnus-article-search-signature)
 662                (point)))
 663         alist entry start begin end numbers prefix)
 664     ;; Get all potential prefixes in `alist'.
 665     (while (< (point) max)
 666       ;; Each line.
 667       (setq begin (point)
 668             end (progn (beginning-of-line 2) (point))
 669             start end)
 670       (goto-char begin)
 671       ;; Ignore standard Supercite attribution prefix.
 672       (when (looking-at gnus-supercite-regexp)
 673         (if (match-end 1)
 674             (setq end (1+ (match-end 1)))
 675           (setq end (1+ begin))))
 676       ;; Ignore very long prefixes.
 677       (when (> end (+ (point) gnus-cite-max-prefix))
 678         (setq end (+ (point) gnus-cite-max-prefix)))
 679       (while (re-search-forward gnus-cite-prefix-regexp (1- end) t)
 680         ;; Each prefix.
 681         (setq end (match-end 0)
 682               prefix (buffer-substring begin end))
 683         (gnus-set-text-properties 0 (length prefix) nil prefix)
 684         (setq entry (assoc prefix alist))
 685         (if entry
 686             (setcdr entry (cons line (cdr entry)))
 687           (push (list prefix line) alist))
 688         (goto-char begin))
 689       (goto-char start)
 690       (setq line (1+ line)))
 691     ;; We got all the potential prefixes.  Now create
 692     ;; `gnus-cite-prefix-alist' containing the oldest prefix for each
 693     ;; line that appears at least gnus-cite-minimum-match-count
 694     ;; times.  First sort them by length.  Longer is older.
 695     (setq alist (sort alist (lambda (a b)
 696                               (> (length (car a)) (length (car b))))))
 697     (while alist
 698       (setq entry (car alist)
 699             prefix (car entry)
 700             numbers (cdr entry)
 701             alist (cdr alist))
 702       (cond ((null numbers)
 703              ;; No lines with this prefix that wasn't also part of
 704              ;; a longer prefix.
 705              )
 706             ((< (length numbers) gnus-cite-minimum-match-count)
 707              ;; Too few lines with this prefix.  We keep it a bit
 708              ;; longer in case it is an exact match for an attribution
 709              ;; line, but we don't remove the line from other
 710              ;; prefixes.
 711              (push entry gnus-cite-prefix-alist))
 712             (t
 713              (push entry
 714                    gnus-cite-prefix-alist)
 715              ;; Remove articles from other prefixes.
 716              (let ((loop alist)
 717                    current)
 718                (while loop
 719                  (setq current (car loop)
 720                        loop (cdr loop))
 721                  (setcdr current
 722                          (gnus-set-difference (cdr current) numbers)))))))))
 723
 724 (defun gnus-cite-parse-attributions ()
 725   (let (al-alist)
 726     ;; Parse attributions
 727     (while (re-search-forward gnus-cite-attribution-suffix (point-max) t)
 728       (let* ((start (match-beginning 0))
 729              (end (match-end 0))
 730              (wrote (count-lines (point-min) end))
 731              (prefix (gnus-cite-find-prefix wrote))
 732              ;; Check previous line for an attribution leader.
 733              (tag (progn
 734                     (beginning-of-line 1)
 735                     (when (looking-at gnus-supercite-secondary-regexp)
 736                       (buffer-substring (match-beginning 1)
 737                                         (match-end 1)))))
 738              (in (progn
 739                    (goto-char start)
 740                    (and (re-search-backward gnus-cite-attribution-prefix
 741                                             (save-excursion
 742                                               (beginning-of-line 0)
 743                                               (point))
 744                                             t)
 745                         (not (re-search-forward gnus-cite-attribution-suffix
 746                                                 start t))
 747                         (count-lines (point-min) (1+ (point)))))))
 748         (when (eq wrote in)
 749           (setq in nil))
 750         (goto-char end)
 751         ;; don't add duplicates
 752         (let ((al (buffer-substring (save-excursion (beginning-of-line 0)
 753                                                     (1+ (point)))
 754                                     end)))
 755           (if (not (assoc al al-alist))
 756               (progn
 757                 (push (list wrote in prefix tag)
 758                       gnus-cite-loose-attribution-alist)
 759                 (push (cons al t) al-alist))))))))
 760
 761 (defun gnus-cite-connect-attributions ()
 762   ;; Connect attributions to citations
 763
 764   ;; No citations have been connected to attribution lines yet.
 765   (setq gnus-cite-loose-prefix-alist (append gnus-cite-prefix-alist nil))
 766
 767   ;; Parse current buffer searching for attribution lines.
 768   ;; Find exact supercite citations.
 769   (gnus-cite-match-attributions 'small nil
 770                                 (lambda (prefix tag)
 771                                   (when tag
 772                                     (concat "\\`"
 773                                             (regexp-quote prefix) "[ \t]*"
 774                                             (regexp-quote tag) ">"))))
 775   ;; Find loose supercite citations after attributions.
 776   (gnus-cite-match-attributions 'small t
 777                                 (lambda (prefix tag)
 778                                   (when tag
 779                                     (concat "\\<"
 780                                             (regexp-quote tag)
 781                                             "\\>"))))
 782   ;; Find loose supercite citations anywhere.
 783   (gnus-cite-match-attributions 'small nil
 784                                 (lambda (prefix tag)
 785                                   (when tag
 786                                     (concat "\\<"
 787                                             (regexp-quote tag)
 788                                             "\\>"))))
 789   ;; Find nested citations after attributions.
 790   (gnus-cite-match-attributions 'small-if-unique t
 791                                 (lambda (prefix tag)
 792                                   (concat "\\`" (regexp-quote prefix) ".+")))
 793   ;; Find nested citations anywhere.
 794   (gnus-cite-match-attributions 'small nil
 795                                 (lambda (prefix tag)
 796                                   (concat "\\`" (regexp-quote prefix) ".+")))
 797   ;; Remove loose prefixes with too few lines.
 798   (let ((alist gnus-cite-loose-prefix-alist)
 799         entry)
 800     (while alist
 801       (setq entry (car alist)
 802             alist (cdr alist))
 803       (when (< (length (cdr entry)) gnus-cite-minimum-match-count)
 804         (setq gnus-cite-prefix-alist
 805               (delq entry gnus-cite-prefix-alist)
 806               gnus-cite-loose-prefix-alist
 807               (delq entry gnus-cite-loose-prefix-alist)))))
 808   ;; Find flat attributions.
 809   (gnus-cite-match-attributions 'first t nil)
 810   ;; Find any attributions (are we getting desperate yet?).
 811   (gnus-cite-match-attributions 'first nil nil))
 812
 813 (defun gnus-cite-match-attributions (sort after fun)
 814   ;; Match all loose attributions and citations (SORT AFTER FUN) .
 815   ;;
 816   ;; If SORT is `small', the citation with the shortest prefix will be
 817   ;; used, if it is `first' the first prefix will be used, if it is
 818   ;; `small-if-unique' the shortest prefix will be used if the
 819   ;; attribution line does not share its own prefix with other
 820   ;; loose attribution lines, otherwise the first prefix will be used.
 821   ;;
 822   ;; If AFTER is non-nil, only citations after the attribution line
 823   ;; will be considered.
 824   ;;
 825   ;; If FUN is non-nil, it will be called with the arguments (WROTE
 826   ;; PREFIX TAG) and expected to return a regular expression.  Only
 827   ;; citations whose prefix matches the regular expression will be
 828   ;; considered.
 829   ;;
 830   ;; WROTE is the attribution line number.
 831   ;; PREFIX is the attribution line prefix.
 832   ;; TAG is the Supercite tag on the attribution line.
 833   (let ((atts gnus-cite-loose-attribution-alist)
 834         (case-fold-search t)
 835         att wrote in prefix tag regexp limit smallest best size)
 836     (while atts
 837       (setq att (car atts)
 838             atts (cdr atts)
 839             wrote (nth 0 att)
 840             in (nth 1 att)
 841             prefix (nth 2 att)
 842             tag (nth 3 att)
 843             regexp (if fun (funcall fun prefix tag) "")
 844             size (cond ((eq sort 'small) t)
 845                        ((eq sort 'first) nil)
 846                        (t (< (length (gnus-cite-find-loose prefix)) 2)))
 847             limit (if after wrote -1)
 848             smallest 1000000
 849             best nil)
 850       (let ((cites gnus-cite-loose-prefix-alist)
 851             cite candidate numbers first compare)
 852         (while cites
 853           (setq cite (car cites)
 854                 cites (cdr cites)
 855                 candidate (car cite)
 856                 numbers (cdr cite)
 857                 first (apply 'min numbers)
 858                 compare (if size (length candidate) first))
 859           (and (> first limit)
 860                regexp
 861                (string-match regexp candidate)
 862                (< compare smallest)
 863                (setq best cite
 864                      smallest compare))))
 865       (if (null best)
 866           ()
 867         (setq gnus-cite-loose-attribution-alist
 868               (delq att gnus-cite-loose-attribution-alist))
 869         (push (cons wrote (car best)) gnus-cite-attribution-alist)
 870         (when in
 871           (push (cons in (car best)) gnus-cite-attribution-alist))
 872         (when (memq best gnus-cite-loose-prefix-alist)
 873           (let ((loop gnus-cite-prefix-alist)
 874                 (numbers (cdr best))
 875                 current)
 876             (setq gnus-cite-loose-prefix-alist
 877                   (delq best gnus-cite-loose-prefix-alist))
 878             (while loop
 879               (setq current (car loop)
 880                     loop (cdr loop))
 881               (if (eq current best)
 882                   ()
 883                 (setcdr current (gnus-set-difference (cdr current) numbers))
 884                 (when (null (cdr current))
 885                   (setq gnus-cite-loose-prefix-alist
 886                         (delq current gnus-cite-loose-prefix-alist)
 887                         atts (delq current atts)))))))))))
 888
 889 (defun gnus-cite-find-loose (prefix)
 890   ;; Return a list of loose attribution lines prefixed by PREFIX.
 891   (let* ((atts gnus-cite-loose-attribution-alist)
 892          att line lines)
 893     (while atts
 894       (setq att (car atts)
 895             line (car att)
 896             atts (cdr atts))
 897       (when (string-equal (gnus-cite-find-prefix line) prefix)
 898         (push line lines)))
 899     lines))
 900
 901 (defun gnus-cite-add-face (number prefix face)
 902   ;; At line NUMBER, ignore PREFIX and add FACE to the rest of the line.
 903   (when face
 904     (let ((inhibit-point-motion-hooks t)
 905           from to overlay)
 906       (goto-char (point-min))
 907       (when (zerop (forward-line (1- number)))
 908         (forward-char (length prefix))
 909         (skip-chars-forward " \t")
 910         (setq from (point))
 911         (end-of-line 1)
 912         (skip-chars-backward " \t")
 913         (setq to (point))
 914         (when (< from to)
 915           (push (setq overlay (gnus-make-overlay from to))
 916                 gnus-cite-overlay-list)
 917           (gnus-overlay-put overlay 'face face))))))
 918
 919 (defun gnus-cite-toggle (prefix)
 920   (save-excursion
 921     (set-buffer gnus-article-buffer)
 922     (gnus-cite-parse-maybe nil t)
 923     (let ((buffer-read-only nil)
 924           (numbers (cdr (assoc prefix gnus-cite-prefix-alist)))
 925           (inhibit-point-motion-hooks t)
 926           number)
 927       (while numbers
 928         (setq number (car numbers)
 929               numbers (cdr numbers))
 930         (goto-char (point-min))
 931         (forward-line (1- number))
 932         (cond ((get-text-property (point) 'invisible)
 933                (remove-text-properties (point) (progn (forward-line 1) (point))
 934                                        gnus-hidden-properties))
 935               ((assq number gnus-cite-attribution-alist))
 936               (t
 937                (gnus-add-text-properties
 938                 (point) (progn (forward-line 1) (point))
 939                 (nconc (list 'article-type 'cite)
 940                        gnus-hidden-properties))))))))
 941
 942 (defun gnus-cite-find-prefix (line)
 943   ;; Return citation prefix for LINE.
 944   (let ((alist gnus-cite-prefix-alist)
 945         (prefix "")
 946         entry)
 947     (while alist
 948       (setq entry (car alist)
 949             alist (cdr alist))
 950       (when (memq line (cdr entry))
 951         (setq prefix (car entry))))
 952     prefix))
 953
 954 (defun gnus-cite-localize ()
 955   "Make the citation variables local to the article buffer."
 956   (let ((vars '(gnus-cite-article
 957                 gnus-cite-overlay-list gnus-cite-prefix-alist
 958                 gnus-cite-attribution-alist gnus-cite-loose-prefix-alist
 959                 gnus-cite-loose-attribution-alist)))
 960     (while vars
 961       (make-local-variable (pop vars)))))
 962
 963 (gnus-ems-redefine)
 964
 965 (provide 'gnus-cite)
 966
 967 ;;; gnus-cite.el ends here