*** empty log message ***
[gnus] / lisp / gnus-cite.el
index 79ff1f9..51a927d 100644 (file)
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING.  If not, write to the
+;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+;; Boston, MA 02111-1307, USA.
 
 ;;; Commentary:
 
 ;;; Code:
 
+(require 'gnus-load)
 (require 'gnus)
-(require 'gnus-msg)
-(require 'gnus-ems)
-
-(eval-and-compile
-  (autoload 'gnus-article-add-button "gnus-vis"))
+(require 'gnus-art)
+(require 'gnus-range)
 
 ;;; Customization:
 
+(defvar gnus-cited-text-button-line-format "%(%{[...]%}%)\n"
+  "Format of cited text buttons.")
+
+(defvar gnus-cited-lines-visible nil
+  "The number of lines of hidden cited text to remain visible.")
+
 (defvar gnus-cite-parse-max-size 25000
   "Maximum article size (in bytes) where parsing citations is allowed.
 Set it to nil to parse all articles.")
@@ -47,31 +52,16 @@ Set it to nil to parse all articles.")
 (defvar gnus-supercite-regexp 
   (concat "^\\(" gnus-cite-prefix-regexp "\\)? *"
          ">>>>> +\"\\([^\"\n]+\\)\" +==")
-  "Regexp matching normal SuperCite attribution lines.
+  "Regexp matching normal Supercite attribution lines.
 The first grouping must match prefixes added by other packages.")
 
 (defvar gnus-supercite-secondary-regexp "^.*\"\\([^\"\n]+\\)\" +=="
-  "Regexp matching mangled SuperCite attribution lines.
-The first regexp group should match the SuperCite attribution.")
+  "Regexp matching mangled Supercite attribution lines.
+The first regexp group should match the Supercite attribution.")
 
 (defvar gnus-cite-minimum-match-count 2
   "Minimum number of identical prefixes before we believe it's a citation.")
 
-;see gnus-cus.el
-;(defvar gnus-cite-face-list 
-;  (if (eq gnus-display-type 'color)
-;      (if (eq gnus-background-mode 'dark) 'light 'dark)
-;    '(italic))
-;  "Faces used for displaying different citations.
-;It is either a list of face names, or one of the following special
-;values:
-
-;dark: Create faces from `gnus-face-dark-name-list'.
-;light: Create faces from `gnus-face-light-name-list'.
-
-;The variable `gnus-make-foreground' determines whether the created
-;faces change the foreground or the background colors.")
-
 (defvar gnus-cite-attribution-prefix "in article\\|in <"
   "Regexp matching the beginning of an attribution line.")
 
@@ -80,38 +70,34 @@ The first regexp group should match the SuperCite attribution.")
   "Regexp matching the end of an attribution line.
 The text matching the first grouping will be used as a button.")
 
-;see gnus-cus.el
-;(defvar gnus-cite-attribution-face 'underline
-;  "Face used for attribution lines.
-;It is merged with the face for the cited text belonging to the attribution.")
-
-;see gnus-cus.el
-;(defvar gnus-cite-hide-percentage 50
-;  "Only hide cited text if it is larger than this percent of the body.")
-
-;see gnus-cus.el
-;(defvar gnus-cite-hide-absolute 10
-;  "Only hide cited text if there is at least this number of cited lines.")
-
-;see gnus-cus.el
-;(defvar gnus-face-light-name-list
-;  '("light blue" "light cyan" "light yellow" "light pink"
-;    "pale green" "beige" "orange" "magenta" "violet" "medium purple"
-;    "turquoise")
-;  "Names of light colors.")
-
-;see gnus-cus.el
-;(defvar gnus-face-dark-name-list
-;  '("dark salmon" "firebrick"
-;    "dark green" "dark orange" "dark khaki" "dark violet"
-;    "dark turquoise")
-;  "Names of dark colors.")
+(defvar gnus-cite-attribution-face 'underline
+  "Face used for attribution lines.
+It is merged with the face for the cited text belonging to the attribution.")
+
+(defvar gnus-cite-face-list 
+  (cond ((not (eq gnus-display-type 'color))
+        '(italic))
+       ((eq gnus-background-mode 'dark)
+        (mapcar 'gnus-make-face 
+                gnus-face-light-name-list))
+       (t 
+        (mapcar 'gnus-make-face 
+                gnus-face-dark-name-list)))
+  "List of faces used for highlighting citations. 
+
+When there are citations from multiple articles in the same message,
+Gnus will try to give each citation from each article its own face.
+This should make it easier to see who wrote what.")
+
+(defvar gnus-cite-hide-percentage 50
+  "Only hide excess citation if above this percentage of the body.")
+
+(defvar gnus-cite-hide-absolute 10
+  "Only hide excess citation if above this number of lines in the body.")
 
 ;;; Internal Variables:
 
-(defvar gnus-article-length nil)
-;; Length of article last time we parsed it.
-;; BUG! KLUDGE! UGLY! FIX ME!
+(defvar gnus-cite-article nil)
 
 (defvar gnus-cite-prefix-alist nil)
 ;; Alist of citation prefixes.  
@@ -132,7 +118,13 @@ The text matching the first grouping will be used as a button.")
 ;; WROTE: is the attribution line number
 ;; IN: is the line number of the previous line if part of the same attribution,
 ;; PREFIX: Is the citation prefix of the attribution line(s), and
-;; TAG: Is a SuperCite tag, if any.
+;; TAG: Is a Supercite tag, if any.
+
+(defvar gnus-cited-text-button-line-format-alist 
+  `((?b beg ?d)
+    (?e end ?d)
+    (?l (- end beg) ?d)))
+(defvar gnus-cited-text-button-line-format-spec nil)
 
 ;;; Commands:
 
@@ -207,17 +199,13 @@ Lines matching `gnus-cite-attribution-suffix' and perhaps
              skip (gnus-cite-find-prefix number))
        (gnus-cite-add-face number skip gnus-cite-attribution-face)))))
 
-(defun gnus-article-fill-cited-article (&optional force)
-  "Do word wrapping in the current article."
-  (interactive (list t))
+(defun gnus-dissect-cited-text ()
+  "Dissect the article buffer looking for cited text."
   (save-excursion
     (set-buffer gnus-article-buffer)
-    (gnus-cite-parse-maybe force)
-    (let ((buffer-read-only nil)
-         (alist gnus-cite-prefix-alist)
-         (inhibit-point-motion-hooks t)
-         prefix numbers number marks
-         (adaptive-fill-mode nil))
+    (gnus-cite-parse-maybe)
+    (let ((alist gnus-cite-prefix-alist)
+         prefix numbers number marks m)
       ;; Loop through citation prefixes.
       (while alist
        (setq numbers (pop alist)
@@ -237,7 +225,7 @@ Lines matching `gnus-cite-attribution-suffix' and perhaps
       (search-forward "\n\n" nil t)
       (push (cons (point-marker) "") marks)
       (goto-char (point-max))
-      (re-search-backward gnus-signature-separator nil t)
+      (article-search-signature)
       (push (cons (point-marker) "") marks)
       (setq marks (sort marks (lambda (m1 m2) (< (car m1) (car m2)))))
       (let* ((omarks marks))
@@ -252,48 +240,108 @@ Lines matching `gnus-cite-attribution-suffix' and perhaps
                (setq omarks (cdr omarks)))
            (push (car omarks) marks))
          (setq omarks (cdr omarks)))
-       (push (car omarks) marks)
-       (setq marks (nreverse marks)))
+       (when (car omarks)
+         (push (car omarks) marks))
+       (setq marks (setq m (nreverse marks)))
+       (while (cddr m)
+         (if (and (equal (cdadr m) "")
+                  (equal (cdar m) (cdaddr m))
+                  (goto-char (caadr m))
+                  (forward-line 1)
+                  (= (point) (caaddr m)))
+             (setcdr m (cdddr m))
+           (setq m (cdr m))))
+       marks))))
+           
+(defun gnus-article-fill-cited-article (&optional force)
+  "Do word wrapping in the current article."
+  (interactive (list t))
+  (save-excursion
+    (set-buffer gnus-article-buffer)
+    (let ((buffer-read-only nil)
+         (inhibit-point-motion-hooks t)
+         (marks (gnus-dissect-cited-text))
+         (adaptive-fill-mode nil))
       (save-restriction
        (while (cdr marks)
          (widen)
-         (narrow-to-region (car (car marks)) (car (cadr marks)))
-         (let ((adaptive-fill-regexp (concat "^" (regexp-quote
-                                                  (cdr (car marks)))
-                                             " *"))
-               (fill-prefix (cdr (car marks)))
-               )
+         (narrow-to-region (caar marks) (caadr marks))
+         (let ((adaptive-fill-regexp
+                (concat "^" (regexp-quote (cdar marks)) " *"))
+               (fill-prefix (cdar marks)))
            (fill-region (point-min) (point-max)))
          (set-marker (caar marks) nil)
          (setq marks (cdr marks)))
-       (set-marker (caar marks) nil)))))
+       (when marks
+         (set-marker (caar marks) nil))))))
 
 (defun gnus-article-hide-citation (&optional arg force)
   "Toggle hiding of all cited text except attribution lines.
 See the documentation for `gnus-article-highlight-citation'.
 If given a negative prefix, always show; if given a positive prefix,
 always hide."
-  (interactive (list current-prefix-arg 'force))
-  (unless (gnus-article-check-hidden-text 'cite arg)
-    (save-excursion
-      (set-buffer gnus-article-buffer)
-      (gnus-cite-parse-maybe force)
+  (interactive (append (article-hidden-arg) (list 'force)))
+  (setq gnus-cited-text-button-line-format-spec 
+       (gnus-parse-format gnus-cited-text-button-line-format 
+                          gnus-cited-text-button-line-format-alist t))
+  (save-excursion
+    (set-buffer gnus-article-buffer)
+    (cond
+     ((article-check-hidden-text 'cite arg)
+      t)
+     ((article-text-type-exists-p 'cite)
+      (let ((buffer-read-only nil))
+       (article-hide-text-of-type 'cite)))
+     (t
       (let ((buffer-read-only nil)
-           (alist gnus-cite-prefix-alist)
+           (marks (gnus-dissect-cited-text))
            (inhibit-point-motion-hooks t)
-           (props (nconc (list 'gnus-type 'cite)
+           (props (nconc (list 'article-type 'cite)
                          gnus-hidden-properties))
-           numbers number)
-       (while alist
-         (setq numbers (cdr (car alist))
-               alist (cdr alist))
-         (while numbers
-           (setq number (car numbers)
-                 numbers (cdr numbers))
-           (goto-line number)
-           (or (assq number gnus-cite-attribution-alist)
-               (add-text-properties 
-                (point) (progn (forward-line 1) (point)) props))))))))
+           beg end)
+       (while marks
+         (setq beg nil
+               end nil)
+         (while (and marks (string= (cdar marks) ""))
+           (setq marks (cdr marks)))
+         (when marks 
+           (setq beg (caar marks)))
+         (while (and marks (not (string= (cdar marks) "")))
+           (setq marks (cdr marks)))
+         (when marks
+           (setq end (caar marks)))
+         ;; Skip past lines we want to leave visible.
+         (when (and beg end gnus-cited-lines-visible)
+           (goto-char beg)
+           (forward-line gnus-cited-lines-visible)
+           (if (>= (point) end)
+               (setq beg nil)
+             (setq beg (point-marker))))
+         (when (and beg end)
+           (gnus-add-text-properties beg end props)
+           (goto-char beg)
+           (unless (save-excursion (search-backward "\n\n" nil t))
+             (insert "\n"))
+           (put-text-property
+            (point)
+            (progn
+              (gnus-article-add-button
+               (point)
+               (progn (eval gnus-cited-text-button-line-format-spec) (point))
+               `gnus-article-toggle-cited-text (cons beg end))
+              (point))
+            'article-type 'annotation)
+           (set-marker beg (point)))))))))
+
+(defun gnus-article-toggle-cited-text (region)
+  "Toggle hiding the text in REGION."
+  (let (buffer-read-only)
+    (funcall
+     (if (text-property-any
+         (car region) (1- (cdr region))
+         (car gnus-hidden-properties) (cadr gnus-hidden-properties))
+        'remove-text-properties 'gnus-add-text-properties)
+     (car region) (cdr region) gnus-hidden-properties)))
 
 (defun gnus-article-hide-citation-maybe (&optional arg force)
   "Toggle hiding of cited text that has an attribution line.
@@ -304,8 +352,8 @@ percent and at least `gnus-cite-hide-absolute' lines of the body is
 cited text with attributions.  When called interactively, these two
 variables are ignored.
 See also the documentation for `gnus-article-highlight-citation'."
-  (interactive (list current-prefix-arg 'force))
-  (unless (gnus-article-check-hidden-text 'cite arg)
+  (interactive (append (article-hidden-arg) (list 'force)))
+  (unless (article-check-hidden-text 'cite arg)
     (save-excursion
       (set-buffer gnus-article-buffer)
       (gnus-cite-parse-maybe force)
@@ -318,10 +366,10 @@ See also the documentation for `gnus-article-highlight-citation'."
            (hiden 0)
            total)
        (goto-char (point-max))
-       (re-search-backward gnus-signature-separator nil t)
+       (article-search-signature)
        (setq total (count-lines start (point)))
        (while atts
-         (setq hiden (+ hiden (length (cdr (assoc (cdr (car atts))
+         (setq hiden (+ hiden (length (cdr (assoc (cdar atts)
                                                   gnus-cite-prefix-alist))))
                atts (cdr atts)))
        (if (or force
@@ -330,17 +378,16 @@ See also the documentation for `gnus-article-highlight-citation'."
            (progn
              (setq atts gnus-cite-attribution-alist)
              (while atts
-               (setq total (cdr (assoc (cdr (car atts)) 
-                                       gnus-cite-prefix-alist))
+               (setq total (cdr (assoc (cdar atts) gnus-cite-prefix-alist))
                      atts (cdr atts))
                (while total
                  (setq hiden (car total)
                        total (cdr total))
                  (goto-line hiden)
                  (or (assq hiden gnus-cite-attribution-alist)
-                     (add-text-properties 
+                     (gnus-add-text-properties 
                       (point) (progn (forward-line 1) (point))
-                      (nconc (list 'gnus-type 'cite)
+                      (nconc (list 'article-type 'cite)
                              gnus-hidden-properties)))))))))))
 
 (defun gnus-article-hide-citation-in-followups ()
@@ -351,15 +398,14 @@ See also the documentation for `gnus-article-highlight-citation'."
     (let ((article (cdr gnus-article-current)))
       (unless (save-excursion
                (set-buffer gnus-summary-buffer)
-               (gnus-root-id (mail-header-id 
-                              (gnus-summary-article-header article))))
+               (gnus-article-displayed-root-p article))
        (gnus-article-hide-citation)))))
 
 ;;; Internal functions:
 
 (defun gnus-cite-parse-maybe (&optional force)
   ;; Parse if the buffer has changes since last time.
-  (if (eq gnus-article-length (- (point-max) (point-min)))
+  (if (equal gnus-cite-article gnus-article-current)
       ()
     ;;Reset parser information.
     (setq gnus-cite-prefix-alist nil
@@ -371,7 +417,8 @@ See also the documentation for `gnus-article-highlight-citation'."
             gnus-cite-parse-max-size
             (> (buffer-size) gnus-cite-parse-max-size))
        ()
-      (setq gnus-article-length (- (point-max) (point-min)))
+      (setq gnus-cite-article (cons (car gnus-article-current)
+                                   (cdr gnus-article-current)))
       (gnus-cite-parse))))
 
 (defun gnus-cite-parse ()
@@ -385,7 +432,7 @@ See also the documentation for `gnus-article-highlight-citation'."
        (case-fold-search t)
        (max (save-excursion
               (goto-char (point-max))
-              (re-search-backward gnus-signature-separator nil t)
+              (article-search-signature)
               (point)))
        alist entry start begin end numbers prefix)
     ;; Get all potential prefixes in `alist'.
@@ -395,7 +442,7 @@ See also the documentation for `gnus-article-highlight-citation'."
            end (progn (beginning-of-line 2) (point))
            start end)
       (goto-char begin)
-      ;; Ignore standard SuperCite attribution prefix.
+      ;; Ignore standard Supercite attribution prefix.
       (if (looking-at gnus-supercite-regexp)
          (if (match-end 1)
              (setq end (1+ (match-end 1)))
@@ -407,7 +454,7 @@ See also the documentation for `gnus-article-highlight-citation'."
        ;; Each prefix.
        (setq end (match-end 0)
              prefix (buffer-substring begin end))
-       (set-text-properties 0 (length prefix) nil prefix)
+       (gnus-set-text-properties 0 (length prefix) nil prefix)
        (setq entry (assoc prefix alist))
        (if entry 
            (setcdr entry (cons line (cdr entry)))
@@ -418,7 +465,7 @@ See also the documentation for `gnus-article-highlight-citation'."
     ;; We got all the potential prefixes.  Now create
     ;; `gnus-cite-prefix-alist' containing the oldest prefix for each
     ;; line that appears at least gnus-cite-minimum-match-count
-    ;; times. First sort them by length.  Longer is older.
+    ;; times.  First sort them by length.  Longer is older.
     (setq alist (sort alist (lambda (a b)
                              (> (length (car a)) (length (car b))))))
     (while alist
@@ -543,7 +590,7 @@ See also the documentation for `gnus-article-highlight-citation'."
   ;; 
   ;; WROTE is the attribution line number.
   ;; PREFIX is the attribution line prefix.
-  ;; TAG is the SuperCite tag on the attribution line.
+  ;; TAG is the Supercite tag on the attribution line.
   (let ((atts gnus-cite-loose-attribution-alist)
        (case-fold-search t)
        att wrote in prefix tag regexp limit smallest best size)
@@ -616,18 +663,19 @@ See also the documentation for `gnus-article-highlight-citation'."
 
 (defun gnus-cite-add-face (number prefix face)
   ;; At line NUMBER, ignore PREFIX and add FACE to the rest of the line.
-  (if face
-      (let ((inhibit-point-motion-hooks t)
-           from to)
-       (goto-line number)
+  (when face
+    (let ((inhibit-point-motion-hooks t)
+         from to)
+      (goto-line number)
+      (unless (eobp);; Sometimes things become confused.
        (forward-char (length prefix))
        (skip-chars-forward " \t")
        (setq from (point))
        (end-of-line 1)
        (skip-chars-backward " \t")
        (setq to (point))
-       (if (< from to)
-           (gnus-overlay-put (gnus-make-overlay from to) 'face face)))))
+       (when (< from to)
+         (gnus-overlay-put (gnus-make-overlay from to) 'face face))))))
 
 (defun gnus-cite-toggle (prefix)
   (save-excursion
@@ -645,10 +693,10 @@ See also the documentation for `gnus-article-highlight-citation'."
                                       gnus-hidden-properties))
              ((assq number gnus-cite-attribution-alist))
              (t
-              (add-text-properties 
+              (gnus-add-text-properties 
                (point) (progn (forward-line 1) (point))
-                (nconc (list 'gnus-type 'cite)
-                       gnus-hidden-properties))))))))
+               (nconc (list 'article-type 'cite)
+                      gnus-hidden-properties))))))))
 
 (defun gnus-cite-find-prefix (line)
   ;; Return citation prefix for LINE.
@@ -662,6 +710,11 @@ See also the documentation for `gnus-article-highlight-citation'."
          (setq prefix (car entry))))
     prefix))
 
+(gnus-add-shutdown 'gnus-cache-close 'gnus)
+
+(defun gnus-cache-close ()
+  (setq gnus-cite-prefix-alist nil))
+
 (gnus-ems-redefine)
 
 (provide 'gnus-cite)