git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus-cite.el

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