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

   1 ;;; gnus.el --- a newsreader for GNU Emacs
   2
   3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
   4 ;; 1998, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
   5
   6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   7 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
   8 ;;      Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
   9 ;;      Yoshiki Hayashi <t90553@mail.ecc.u-tokyo.ac.jp>
  10 ;; Keywords: news, mail
  11
  12 ;; This file is part of GNU Emacs.
  13
  14 ;; GNU Emacs is free software; you can redistribute it and/or modify
  15 ;; it under the terms of the GNU General Public License as published by
  16 ;; the Free Software Foundation; either version 2, or (at your option)
  17 ;; any later version.
  18
  19 ;; GNU Emacs is distributed in the hope that it will be useful,
  20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 ;; GNU General Public License for more details.
  23
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  27 ;; Boston, MA 02111-1307, USA.
  28
  29 ;;; Commentary:
  30
  31 ;;; Code:
  32
  33 (eval '(run-hooks 'gnus-load-hook))
  34
  35 (eval-when-compile (require 'cl))
  36 (eval-when-compile (require 'static))
  37
  38 (require 'wid-edit)
  39 (require 'nnheader)
  40
  41 (require 'gnus-vers)
  42
  43 (defgroup gnus nil
  44   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
  45   :group 'news
  46   :group 'mail)
  47
  48 (defgroup gnus-format nil
  49   "Dealing with formatting issues."
  50   :group 'gnus)
  51
  52 (defgroup gnus-charset nil
  53   "Group character set issues."
  54   :link '(custom-manual "(gnus)Charsets")
  55   :version "21.1"
  56   :group 'gnus)
  57
  58 (defgroup gnus-cache nil
  59   "Cache interface."
  60   :link '(custom-manual "(gnus)Article Caching")
  61   :group 'gnus)
  62
  63 (defgroup gnus-registry nil
  64   "Article Registry."
  65   :group 'gnus)
  66
  67 (defgroup gnus-start nil
  68   "Starting your favorite newsreader."
  69   :group 'gnus)
  70
  71 (defgroup gnus-start-server nil
  72   "Server options at startup."
  73   :group 'gnus-start)
  74
  75 ;; These belong to gnus-group.el.
  76 (defgroup gnus-group nil
  77   "Group buffers."
  78   :link '(custom-manual "(gnus)The Group Buffer")
  79   :group 'gnus)
  80
  81 (defgroup gnus-group-foreign nil
  82   "Foreign groups."
  83   :link '(custom-manual "(gnus)Foreign Groups")
  84   :group 'gnus-group)
  85
  86 (defgroup gnus-group-new nil
  87   "Automatic subscription of new groups."
  88   :group 'gnus-group)
  89
  90 (defgroup gnus-group-levels nil
  91   "Group levels."
  92   :link '(custom-manual "(gnus)Group Levels")
  93   :group 'gnus-group)
  94
  95 (defgroup gnus-group-select nil
  96   "Selecting a Group."
  97   :link '(custom-manual "(gnus)Selecting a Group")
  98   :group 'gnus-group)
  99
 100 (defgroup gnus-group-listing nil
 101   "Showing slices of the group list."
 102   :link '(custom-manual "(gnus)Listing Groups")
 103   :group 'gnus-group)
 104
 105 (defgroup gnus-group-visual nil
 106   "Sorting the group buffer."
 107   :link '(custom-manual "(gnus)Group Buffer Format")
 108   :group 'gnus-group
 109   :group 'gnus-visual)
 110
 111 (defgroup gnus-group-various nil
 112   "Various group options."
 113   :link '(custom-manual "(gnus)Scanning New Messages")
 114   :group 'gnus-group)
 115
 116 ;; These belong to gnus-sum.el.
 117 (defgroup gnus-summary nil
 118   "Summary buffers."
 119   :link '(custom-manual "(gnus)The Summary Buffer")
 120   :group 'gnus)
 121
 122 (defgroup gnus-summary-exit nil
 123   "Leaving summary buffers."
 124   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
 125   :group 'gnus-summary)
 126
 127 (defgroup gnus-summary-marks nil
 128   "Marks used in summary buffers."
 129   :link '(custom-manual "(gnus)Marking Articles")
 130   :group 'gnus-summary)
 131
 132 (defgroup gnus-thread nil
 133   "Ordering articles according to replies."
 134   :link '(custom-manual "(gnus)Threading")
 135   :group 'gnus-summary)
 136
 137 (defgroup gnus-summary-format nil
 138   "Formatting of the summary buffer."
 139   :link '(custom-manual "(gnus)Summary Buffer Format")
 140   :group 'gnus-summary)
 141
 142 (defgroup gnus-summary-choose nil
 143   "Choosing Articles."
 144   :link '(custom-manual "(gnus)Choosing Articles")
 145   :group 'gnus-summary)
 146
 147 (defgroup gnus-summary-maneuvering nil
 148   "Summary movement commands."
 149   :link '(custom-manual "(gnus)Summary Maneuvering")
 150   :group 'gnus-summary)
 151
 152 (defgroup gnus-picon nil
 153   "Show pictures of people, domains, and newsgroups."
 154   :group 'gnus-visual)
 155
 156 (defgroup gnus-summary-mail nil
 157   "Mail group commands."
 158   :link '(custom-manual "(gnus)Mail Group Commands")
 159   :group 'gnus-summary)
 160
 161 (defgroup gnus-summary-sort nil
 162   "Sorting the summary buffer."
 163   :link '(custom-manual "(gnus)Sorting")
 164   :group 'gnus-summary)
 165
 166 (defgroup gnus-summary-visual nil
 167   "Highlighting and menus in the summary buffer."
 168   :link '(custom-manual "(gnus)Summary Highlighting")
 169   :group 'gnus-visual
 170   :group 'gnus-summary)
 171
 172 (defgroup gnus-summary-various nil
 173   "Various summary buffer options."
 174   :link '(custom-manual "(gnus)Various Summary Stuff")
 175   :group 'gnus-summary)
 176
 177 (defgroup gnus-summary-pick nil
 178   "Pick mode in the summary buffer."
 179   :link '(custom-manual "(gnus)Pick and Read")
 180   :prefix "gnus-pick-"
 181   :group 'gnus-summary)
 182
 183 (defgroup gnus-summary-tree nil
 184   "Tree display of threads in the summary buffer."
 185   :link '(custom-manual "(gnus)Tree Display")
 186   :prefix "gnus-tree-"
 187   :group 'gnus-summary)
 188
 189 ;; Belongs to gnus-uu.el
 190 (defgroup gnus-extract-view nil
 191   "Viewing extracted files."
 192   :link '(custom-manual "(gnus)Viewing Files")
 193   :group 'gnus-extract)
 194
 195 ;; Belongs to gnus-score.el
 196 (defgroup gnus-score nil
 197   "Score and kill file handling."
 198   :group 'gnus)
 199
 200 (defgroup gnus-score-kill nil
 201   "Kill files."
 202   :group 'gnus-score)
 203
 204 (defgroup gnus-score-adapt nil
 205   "Adaptive score files."
 206   :group 'gnus-score)
 207
 208 (defgroup gnus-score-default nil
 209   "Default values for score files."
 210   :group 'gnus-score)
 211
 212 (defgroup gnus-score-expire nil
 213   "Expiring score rules."
 214   :group 'gnus-score)
 215
 216 (defgroup gnus-score-decay nil
 217   "Decaying score rules."
 218   :group 'gnus-score)
 219
 220 (defgroup gnus-score-files nil
 221   "Score and kill file names."
 222   :group 'gnus-score
 223   :group 'gnus-files)
 224
 225 (defgroup gnus-score-various nil
 226   "Various scoring and killing options."
 227   :group 'gnus-score)
 228
 229 ;; Other
 230 (defgroup gnus-visual nil
 231   "Options controlling the visual fluff."
 232   :group 'gnus
 233   :group 'faces)
 234
 235 (defgroup gnus-agent nil
 236   "Offline support for Gnus."
 237   :group 'gnus)
 238
 239 (defgroup gnus-files nil
 240   "Files used by Gnus."
 241   :group 'gnus)
 242
 243 (defgroup gnus-dribble-file nil
 244   "Auto save file."
 245   :link '(custom-manual "(gnus)Auto Save")
 246   :group 'gnus-files)
 247
 248 (defgroup gnus-newsrc nil
 249   "Storing Gnus state."
 250   :group 'gnus-files)
 251
 252 (defgroup gnus-server nil
 253   "Options related to newsservers and other servers used by Gnus."
 254   :group 'gnus)
 255
 256 (defgroup gnus-server-visual nil
 257   "Highlighting and menus in the server buffer."
 258   :group 'gnus-visual
 259   :group 'gnus-server)
 260
 261 (defgroup gnus-message '((message custom-group))
 262   "Composing replies and followups in Gnus."
 263   :group 'gnus)
 264
 265 (defgroup gnus-meta nil
 266   "Meta variables controlling major portions of Gnus.
 267 In general, modifying these variables does not take affect until Gnus
 268 is restarted, and sometimes reloaded."
 269   :group 'gnus)
 270
 271 (defgroup gnus-various nil
 272   "Other Gnus options."
 273   :link '(custom-manual "(gnus)Various Various")
 274   :group 'gnus)
 275
 276 (defgroup gnus-mime nil
 277   "Variables for controlling the Gnus MIME interface."
 278   :group 'gnus)
 279
 280 (defgroup gnus-exit nil
 281   "Exiting gnus."
 282   :link '(custom-manual "(gnus)Exiting Gnus")
 283   :group 'gnus)
 284
 285 (defgroup gnus-fun nil
 286   "Frivolous Gnus extensions."
 287   :link '(custom-manual "(gnus)Exiting Gnus")
 288   :group 'gnus)
 289
 290 (defcustom gnus-inhibit-startup-message nil
 291   "If non-nil, the startup message will not be displayed.
 292 This variable is used before `.gnus.el' is loaded, so it should
 293 be set in `.emacs' instead."
 294   :group 'gnus-start
 295   :type 'boolean)
 296
 297 (defcustom gnus-play-startup-jingle nil
 298   "If non-nil, play the Gnus jingle at startup."
 299   :group 'gnus-start
 300   :type 'boolean)
 301
 302 (unless (fboundp 'gnus-group-remove-excess-properties)
 303   (defalias 'gnus-group-remove-excess-properties 'ignore))
 304
 305 (unless (fboundp 'gnus-set-text-properties)
 306   (defalias 'gnus-set-text-properties 'set-text-properties))
 307
 308 (unless (featurep 'gnus-xmas)
 309   (defalias 'gnus-make-overlay 'make-overlay)
 310   (defalias 'gnus-delete-overlay 'delete-overlay)
 311   (defalias 'gnus-overlay-put 'overlay-put)
 312   (defalias 'gnus-move-overlay 'move-overlay)
 313   (defalias 'gnus-overlay-buffer 'overlay-buffer)
 314   (defalias 'gnus-overlay-start 'overlay-start)
 315   (defalias 'gnus-overlay-end 'overlay-end)
 316   (defalias 'gnus-extent-detached-p 'ignore)
 317   (defalias 'gnus-extent-start-open 'ignore)
 318   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
 319   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
 320   (defalias 'gnus-character-to-event 'identity)
 321   (defalias 'gnus-assq-delete-all 'assq-delete-all)
 322   (defalias 'gnus-add-text-properties 'add-text-properties)
 323   (defalias 'gnus-put-text-property 'put-text-property)
 324   (defvar gnus-mode-line-image-cache t)
 325   (if (fboundp 'find-image)
 326       (defun gnus-mode-line-buffer-identification (line)
 327         (let ((str (car-safe line)))
 328           (if (and (stringp str)
 329                    (string-match "^Gnus:" str))
 330               (progn (add-text-properties
 331                       0 5
 332                       (list 'display
 333                             (if (eq t gnus-mode-line-image-cache)
 334                                 (setq gnus-mode-line-image-cache
 335                                       (find-image
 336                                        '((:type xpm :file "gnus-pointer.xpm"
 337                                                 :ascent center)
 338                                          (:type xbm :file "gnus-pointer.xbm"
 339                                                 :ascent center))))
 340                               gnus-mode-line-image-cache)
 341                             'help-echo (format
 342                                         "This is %s, %s."
 343                                         gnus-version (gnus-emacs-version)))
 344                       str)
 345                      (list str))
 346             line)))
 347     (defalias 'gnus-mode-line-buffer-identification 'identity))
 348   (defalias 'gnus-characterp 'numberp)
 349   (defalias 'gnus-deactivate-mark 'deactivate-mark)
 350   (defalias 'gnus-window-edges 'window-edges)
 351   (defalias 'gnus-key-press-event-p 'numberp)
 352   ;;(defalias 'gnus-decode-rfc1522 'ignore)
 353   )
 354
 355 ;; We define these group faces here to avoid the display
 356 ;; update forced when creating new faces.
 357
 358 (defface gnus-group-news-1-face
 359   '((((class color)
 360       (background dark))
 361      (:foreground "PaleTurquoise" :bold t))
 362     (((class color)
 363       (background light))
 364      (:foreground "ForestGreen" :bold t))
 365     (t
 366      ()))
 367   "Level 1 newsgroup face.")
 368
 369 (defface gnus-group-news-1-empty-face
 370   '((((class color)
 371       (background dark))
 372      (:foreground "PaleTurquoise"))
 373     (((class color)
 374       (background light))
 375      (:foreground "ForestGreen"))
 376     (t
 377      ()))
 378   "Level 1 empty newsgroup face.")
 379
 380 (defface gnus-group-news-2-face
 381   '((((class color)
 382       (background dark))
 383      (:foreground "turquoise" :bold t))
 384     (((class color)
 385       (background light))
 386      (:foreground "CadetBlue4" :bold t))
 387     (t
 388      ()))
 389   "Level 2 newsgroup face.")
 390
 391 (defface gnus-group-news-2-empty-face
 392   '((((class color)
 393       (background dark))
 394      (:foreground "turquoise"))
 395     (((class color)
 396       (background light))
 397      (:foreground "CadetBlue4"))
 398     (t
 399      ()))
 400   "Level 2 empty newsgroup face.")
 401
 402 (defface gnus-group-news-3-face
 403   '((((class color)
 404       (background dark))
 405      (:bold t))
 406     (((class color)
 407       (background light))
 408      (:bold t))
 409     (t
 410      ()))
 411   "Level 3 newsgroup face.")
 412
 413 (defface gnus-group-news-3-empty-face
 414   '((((class color)
 415       (background dark))
 416      ())
 417     (((class color)
 418       (background light))
 419      ())
 420     (t
 421      ()))
 422   "Level 3 empty newsgroup face.")
 423
 424 (defface gnus-group-news-4-face
 425   '((((class color)
 426       (background dark))
 427      (:bold t))
 428     (((class color)
 429       (background light))
 430      (:bold t))
 431     (t
 432      ()))
 433   "Level 4 newsgroup face.")
 434
 435 (defface gnus-group-news-4-empty-face
 436   '((((class color)
 437       (background dark))
 438      ())
 439     (((class color)
 440       (background light))
 441      ())
 442     (t
 443      ()))
 444   "Level 4 empty newsgroup face.")
 445
 446 (defface gnus-group-news-5-face
 447   '((((class color)
 448       (background dark))
 449      (:bold t))
 450     (((class color)
 451       (background light))
 452      (:bold t))
 453     (t
 454      ()))
 455   "Level 5 newsgroup face.")
 456
 457 (defface gnus-group-news-5-empty-face
 458   '((((class color)
 459       (background dark))
 460      ())
 461     (((class color)
 462       (background light))
 463      ())
 464     (t
 465      ()))
 466   "Level 5 empty newsgroup face.")
 467
 468 (defface gnus-group-news-6-face
 469   '((((class color)
 470       (background dark))
 471      (:bold t))
 472     (((class color)
 473       (background light))
 474      (:bold t))
 475     (t
 476      ()))
 477   "Level 6 newsgroup face.")
 478
 479 (defface gnus-group-news-6-empty-face
 480   '((((class color)
 481       (background dark))
 482      ())
 483     (((class color)
 484       (background light))
 485      ())
 486     (t
 487      ()))
 488   "Level 6 empty newsgroup face.")
 489
 490 (defface gnus-group-news-low-face
 491   '((((class color)
 492       (background dark))
 493      (:foreground "DarkTurquoise" :bold t))
 494     (((class color)
 495       (background light))
 496      (:foreground "DarkGreen" :bold t))
 497     (t
 498      ()))
 499   "Low level newsgroup face.")
 500
 501 (defface gnus-group-news-low-empty-face
 502   '((((class color)
 503       (background dark))
 504      (:foreground "DarkTurquoise"))
 505     (((class color)
 506       (background light))
 507      (:foreground "DarkGreen"))
 508     (t
 509      ()))
 510   "Low level empty newsgroup face.")
 511
 512 (defface gnus-group-mail-1-face
 513   '((((class color)
 514       (background dark))
 515      (:foreground "aquamarine1" :bold t))
 516     (((class color)
 517       (background light))
 518      (:foreground "DeepPink3" :bold t))
 519     (t
 520      (:bold t)))
 521   "Level 1 mailgroup face.")
 522
 523 (defface gnus-group-mail-1-empty-face
 524   '((((class color)
 525       (background dark))
 526      (:foreground "aquamarine1"))
 527     (((class color)
 528       (background light))
 529      (:foreground "DeepPink3"))
 530     (t
 531      (:italic t :bold t)))
 532   "Level 1 empty mailgroup face.")
 533
 534 (defface gnus-group-mail-2-face
 535   '((((class color)
 536       (background dark))
 537      (:foreground "aquamarine2" :bold t))
 538     (((class color)
 539       (background light))
 540      (:foreground "HotPink3" :bold t))
 541     (t
 542      (:bold t)))
 543   "Level 2 mailgroup face.")
 544
 545 (defface gnus-group-mail-2-empty-face
 546   '((((class color)
 547       (background dark))
 548      (:foreground "aquamarine2"))
 549     (((class color)
 550       (background light))
 551      (:foreground "HotPink3"))
 552     (t
 553      (:bold t)))
 554   "Level 2 empty mailgroup face.")
 555
 556 (defface gnus-group-mail-3-face
 557   '((((class color)
 558       (background dark))
 559      (:foreground "aquamarine3" :bold t))
 560     (((class color)
 561       (background light))
 562      (:foreground "magenta4" :bold t))
 563     (t
 564      (:bold t)))
 565   "Level 3 mailgroup face.")
 566
 567 (defface gnus-group-mail-3-empty-face
 568   '((((class color)
 569       (background dark))
 570      (:foreground "aquamarine3"))
 571     (((class color)
 572       (background light))
 573      (:foreground "magenta4"))
 574     (t
 575      ()))
 576   "Level 3 empty mailgroup face.")
 577
 578 (defface gnus-group-mail-low-face
 579   '((((class color)
 580       (background dark))
 581      (:foreground "aquamarine4" :bold t))
 582     (((class color)
 583       (background light))
 584      (:foreground "DeepPink4" :bold t))
 585     (t
 586      (:bold t)))
 587   "Low level mailgroup face.")
 588
 589 (defface gnus-group-mail-low-empty-face
 590   '((((class color)
 591       (background dark))
 592      (:foreground "aquamarine4"))
 593     (((class color)
 594       (background light))
 595      (:foreground "DeepPink4"))
 596     (t
 597      (:bold t)))
 598   "Low level empty mailgroup face.")
 599
 600 ;; Summary mode faces.
 601
 602 (defface gnus-summary-selected-face '((t
 603                                        (:underline t)))
 604   "Face used for selected articles.")
 605
 606 (defface gnus-summary-cancelled-face
 607   '((((class color))
 608      (:foreground "yellow" :background "black")))
 609   "Face used for cancelled articles.")
 610
 611 (defface gnus-summary-high-ticked-face
 612   '((((class color)
 613       (background dark))
 614      (:foreground "pink" :bold t))
 615     (((class color)
 616       (background light))
 617      (:foreground "firebrick" :bold t))
 618     (t
 619      (:bold t)))
 620   "Face used for high interest ticked articles.")
 621
 622 (defface gnus-summary-low-ticked-face
 623   '((((class color)
 624       (background dark))
 625      (:foreground "pink" :italic t))
 626     (((class color)
 627       (background light))
 628      (:foreground "firebrick" :italic t))
 629     (t
 630      (:italic t)))
 631   "Face used for low interest ticked articles.")
 632
 633 (defface gnus-summary-normal-ticked-face
 634   '((((class color)
 635       (background dark))
 636      (:foreground "pink"))
 637     (((class color)
 638       (background light))
 639      (:foreground "firebrick"))
 640     (t
 641      ()))
 642   "Face used for normal interest ticked articles.")
 643
 644 (defface gnus-summary-high-ancient-face
 645   '((((class color)
 646       (background dark))
 647      (:foreground "SkyBlue" :bold t))
 648     (((class color)
 649       (background light))
 650      (:foreground "RoyalBlue" :bold t))
 651     (t
 652      (:bold t)))
 653   "Face used for high interest ancient articles.")
 654
 655 (defface gnus-summary-low-ancient-face
 656   '((((class color)
 657       (background dark))
 658      (:foreground "SkyBlue" :italic t))
 659     (((class color)
 660       (background light))
 661      (:foreground "RoyalBlue" :italic t))
 662     (t
 663      (:italic t)))
 664   "Face used for low interest ancient articles.")
 665
 666 (defface gnus-summary-normal-ancient-face
 667   '((((class color)
 668       (background dark))
 669      (:foreground "SkyBlue"))
 670     (((class color)
 671       (background light))
 672      (:foreground "RoyalBlue"))
 673     (t
 674      ()))
 675   "Face used for normal interest ancient articles.")
 676
 677 (defface gnus-summary-high-undownloaded-face
 678    '((((class color)
 679        (background light))
 680       (:bold t :foreground "cyan4"))
 681      (((class color) (background dark))
 682       (:bold t :foreground "LightGray"))
 683      (t (:inverse-video t :bold t)))
 684   "Face used for high interest uncached articles.")
 685
 686 (defface gnus-summary-low-undownloaded-face
 687    '((((class color)
 688        (background light))
 689       (:italic t :foreground "cyan4" :bold nil))
 690      (((class color) (background dark))
 691       (:italic t :foreground "LightGray" :bold nil))
 692      (t (:inverse-video t :italic t)))
 693   "Face used for low interest uncached articles.")
 694
 695 (defface gnus-summary-normal-undownloaded-face
 696    '((((class color)
 697        (background light))
 698       (:foreground "cyan4" :bold nil))
 699      (((class color) (background dark))
 700       (:foreground "LightGray" :bold nil))
 701      (t (:inverse-video t)))
 702   "Face used for normal interest uncached articles.")
 703
 704 (defface gnus-summary-high-unread-face
 705   '((t
 706      (:bold t)))
 707   "Face used for high interest unread articles.")
 708
 709 (defface gnus-summary-low-unread-face
 710   '((t
 711      (:italic t)))
 712   "Face used for low interest unread articles.")
 713
 714 (defface gnus-summary-normal-unread-face
 715   '((t
 716      ()))
 717   "Face used for normal interest unread articles.")
 718
 719 (defface gnus-summary-incorporated-face
 720   '((t
 721      ()))
 722   "Face used for incorporated articles.")
 723
 724 (defface gnus-summary-high-read-face
 725   '((((class color)
 726       (background dark))
 727      (:foreground "PaleGreen"
 728                   :bold t))
 729     (((class color)
 730       (background light))
 731      (:foreground "DarkGreen"
 732                   :bold t))
 733     (t
 734      (:bold t)))
 735   "Face used for high interest read articles.")
 736
 737 (defface gnus-summary-low-read-face
 738   '((((class color)
 739       (background dark))
 740      (:foreground "PaleGreen"
 741                   :italic t))
 742     (((class color)
 743       (background light))
 744      (:foreground "DarkGreen"
 745                   :italic t))
 746     (t
 747      (:italic t)))
 748   "Face used for low interest read articles.")
 749
 750 (defface gnus-summary-normal-read-face
 751   '((((class color)
 752       (background dark))
 753      (:foreground "PaleGreen"))
 754     (((class color)
 755       (background light))
 756      (:foreground "DarkGreen"))
 757     (t
 758      ()))
 759   "Face used for normal interest read articles.")
 760
 761
 762 ;;;
 763 ;;; Gnus buffers
 764 ;;;
 765
 766 (defvar gnus-buffers nil)
 767
 768 (defun gnus-get-buffer-create (name)
 769   "Do the same as `get-buffer-create', but store the created buffer."
 770   (or (get-buffer name)
 771       (car (push (get-buffer-create name) gnus-buffers))))
 772
 773 (defun gnus-add-buffer ()
 774   "Add the current buffer to the list of Gnus buffers."
 775   (push (current-buffer) gnus-buffers))
 776
 777 (defmacro gnus-kill-buffer (buffer)
 778   "Kill BUFFER and remove from the list of Gnus buffers."
 779   `(let ((buf ,buffer))
 780      (when (gnus-buffer-exists-p buf)
 781        (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
 782        (kill-buffer buf))))
 783
 784 (defun gnus-buffers ()
 785   "Return a list of live Gnus buffers."
 786   (while (and gnus-buffers
 787               (not (buffer-name (car gnus-buffers))))
 788     (pop gnus-buffers))
 789   (let ((buffers gnus-buffers))
 790     (while (cdr buffers)
 791       (if (buffer-name (cadr buffers))
 792           (pop buffers)
 793         (setcdr buffers (cddr buffers)))))
 794   gnus-buffers)
 795
 796 ;;; Splash screen.
 797
 798 (defvar gnus-group-buffer "*Group*")
 799
 800 (eval-and-compile
 801   (autoload 'gnus-play-jingle "gnus-audio"))
 802
 803 (defface gnus-splash-face
 804   '((((class color)
 805       (background dark))
 806      (:foreground "#888888"))
 807     (((class color)
 808       (background light))
 809      (:foreground "#888888"))
 810     (t
 811      ()))
 812   "Face for the splash screen.")
 813
 814 (defun gnus-splash ()
 815   (save-excursion
 816     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
 817     (let ((buffer-read-only nil))
 818       (erase-buffer)
 819       (unless gnus-inhibit-startup-message
 820         (gnus-group-startup-message)
 821         (sit-for 0)
 822         (when gnus-play-startup-jingle
 823           (gnus-play-jingle))))))
 824
 825 (defun gnus-indent-rigidly (start end arg)
 826   "Indent rigidly using only spaces and no tabs."
 827   (save-excursion
 828     (save-restriction
 829       (narrow-to-region start end)
 830       (let ((tab-width 8))
 831         (indent-rigidly start end arg)
 832         ;; We translate tabs into spaces -- not everybody uses
 833         ;; an 8-character tab.
 834         (goto-char (point-min))
 835         (while (search-forward "\t" nil t)
 836           (replace-match "        " t t))))))
 837
 838 (defvar gnus-simple-splash nil)
 839
 840 ;;(format "%02x%02x%02x" 114 66 20) "724214"
 841
 842 (defvar gnus-logo-color-alist
 843   '((flame "#cc3300" "#ff2200")
 844     (pine "#c0cc93" "#f8ffb8")
 845     (moss "#a1cc93" "#d2ffb8")
 846     (irish "#04cc90" "#05ff97")
 847     (sky "#049acc" "#05deff")
 848     (tin "#6886cc" "#82b6ff")
 849     (velvet "#7c68cc" "#8c82ff")
 850     (grape "#b264cc" "#cf7df")
 851     (labia "#cc64c2" "#fd7dff")
 852     (berry "#cc6485" "#ff7db5")
 853     (dino "#724214" "#1e3f03")
 854     (oort "#cccccc" "#888888")
 855     (storm "#666699" "#99ccff")
 856     (pdino "#9999cc" "#99ccff")
 857     (purp "#9999cc" "#666699")
 858     (no "#ff0000" "#ffff00")
 859     (neutral "#b4b4b4" "#878787")
 860     (september "#bf9900" "#ffcc00"))
 861   "Color alist used for the Gnus logo.")
 862
 863 (defcustom gnus-logo-color-style 'no
 864   "*Color styles used for the Gnus logo."
 865   :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
 866                            gnus-logo-color-alist))
 867   :group 'gnus-xmas)
 868
 869 (defvar gnus-logo-colors
 870   (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
 871   "Colors used for the Gnus logo.")
 872
 873 (defun gnus-group-startup-message (&optional x y)
 874   "Insert startup message in current buffer."
 875   ;; Insert the message.
 876   (erase-buffer)
 877   (cond
 878    ((and (fboundp 'find-image)
 879          (display-graphic-p)
 880          (let* ((bg (face-background 'default))
 881                 (fg (face-foreground 'gnus-splash-face))
 882                 (data-directory (nnheader-find-etc-directory "gnus"))
 883                 (image (find-image
 884                         `((:type xpm :file "gnus.xpm"
 885                                  :color-symbols
 886                                  (("thing" . ,(car gnus-logo-colors))
 887                                   ("shadow" . ,(cadr gnus-logo-colors))
 888                                   ("oort" . "#eeeeee")
 889                                   ("background" . ,bg)))
 890                           (:type pbm :file "gnus.pbm"
 891                                  ;; Account for the pbm's blackground.
 892                                  :background ,bg :foreground ,fg)
 893                           (:type xbm :file "gnus.xbm"
 894                                  ;; Account for the xbm's blackground.
 895                                  :background ,bg :foreground ,fg)))))
 896            (when image
 897              (insert
 898               (propertize
 899                (concat gnus-product-name " " gnus-version-number
 900                        (if (zerop (string-to-number gnus-revision-number))
 901                            ""
 902                          (concat " (r" gnus-revision-number ")"))
 903                        " based on " gnus-original-product-name " v"
 904                        gnus-original-version-number)
 905                'face `(variable-pitch :background ,bg :foreground ,fg)))
 906              (let ((fill-column (window-width)))
 907                (center-region (point-min) (point)))
 908              (let ((size (image-size image)))
 909                (insert-char ?\n (max 1 (round (- (window-height)
 910                                                  (or y (cdr size))) 2)))
 911                (insert
 912                 (propertize " " 'display
 913                             `(space :align-to
 914                                     ,(max 0 (round (- (window-width)
 915                                                       (or x (car size))) 2)))))
 916                (insert-image image))
 917              (setq gnus-simple-splash nil)
 918              t))))
 919    (t
 920     (insert "
 921           _    ___ _             _
 922           _ ___ __ ___  __    _ ___
 923           __   _     ___    __  ___
 924               _           ___     _
 925              _  _ __             _
 926              ___   __            _
 927                    __           _
 928                     _      _   _
 929                    _      _    _
 930                       _  _    _
 931                   __  ___
 932                  _   _ _     _
 933                 _   _
 934               _    _
 935              _    _
 936             _
 937           __
 938
 939 "
 940             )
 941     (goto-char (point-min))
 942     (insert gnus-product-name " " gnus-version-number
 943             (if (zerop (string-to-number gnus-revision-number))
 944                 ""
 945               (concat " (r" gnus-revision-number ")"))
 946             " based on " gnus-original-product-name " v"
 947             gnus-original-version-number)
 948     (insert-char ?\  (prog1
 949                          (max 0 (/ (- (window-width) (point)) 2))
 950                        (goto-char (point-min))))
 951     (forward-line 1)
 952     ;; And then hack it.
 953     (gnus-indent-rigidly (point) (point-max)
 954                          (/ (max (- (window-width) (or x 46)) 0) 2))
 955     (goto-char (point-min))
 956     (forward-line 1)
 957     (let* ((pheight (count-lines (point-min) (point-max)))
 958            (wheight (window-height))
 959            (rest (- wheight pheight)))
 960       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
 961     ;; Fontify some.
 962     (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
 963     (setq gnus-simple-splash t)))
 964   (goto-char (point-min))
 965   (setq mode-line-buffer-identification (concat " " gnus-version))
 966   (set-buffer-modified-p t))
 967
 968 (eval-when (load)
 969   (let ((command (format "%s" this-command)))
 970     (if (and (string-match "gnus" command)
 971              (not (string-match "gnus-other-frame" command)))
 972         (gnus-splash)
 973       (gnus-get-buffer-create gnus-group-buffer))))
 974
 975 ;;; Do the rest.
 976
 977 (require 'gnus-util)
 978 (require 'nnheader)
 979
 980 (defcustom gnus-parameters nil
 981   "Alist of group parameters.
 982
 983 For example:
 984    ((\"mail\\\\..*\"  (gnus-show-threads nil)
 985                   (gnus-use-scoring nil)
 986                   (gnus-summary-line-format
 987                         \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
 988                   (gcc-self . t)
 989                   (display . all))
 990      (\"mail\\\\.me\" (gnus-use-scoring  t))
 991      (\"list\\\\..*\" (total-expire . t)
 992                   (broken-reply-to . t)))"
 993   :group 'gnus-group-various
 994   :type '(repeat (cons regexp
 995                        (repeat sexp))))
 996
 997 (defvar gnus-group-parameters-more nil)
 998
 999 (defvar gnus-colon-keywords
1000   (eval-when-compile
1001     (when (boundp 'dgnushack-colon-keywords)
1002       (symbol-value 'dgnushack-colon-keywords)))
1003   "List of the colon keywords should be bound at run-time.  This variable
1004 defaults to a proper value only if this file is byte-compiled by make.")
1005
1006 (dolist (keyword gnus-colon-keywords)
1007   (set keyword keyword))
1008
1009 (defmacro gnus-define-group-parameter (param &rest rest)
1010   "Define a group parameter PARAM.
1011 REST is a plist of following:
1012 :type               One of `bool', `list' or nil.
1013 :function           The name of the function.
1014 :function-document  The documentation of the function.
1015 :parameter-type     The type for customizing the parameter.
1016 :parameter-document The documentation for the parameter.
1017 :variable           The name of the variable.
1018 :variable-document  The documentation for the variable.
1019 :variable-group     The group for customizing the variable.
1020 :variable-type      The type for customizing the variable.
1021 :variable-default   The default value of the variable."
1022   (let* ((type (plist-get rest :type))
1023          (parameter-type (plist-get rest :parameter-type))
1024          (parameter-document (plist-get rest :parameter-document))
1025          (function (or (plist-get rest :function)
1026                        (intern (format "gnus-parameter-%s" param))))
1027          (function-document (or (plist-get rest :function-document) ""))
1028          (variable (or (plist-get rest :variable)
1029                        (intern (format "gnus-parameter-%s-alist" param))))
1030          (variable-document (or (plist-get rest :variable-document) ""))
1031          (variable-group (plist-get rest :variable-group))
1032          (variable-type (or (plist-get rest :variable-type)
1033                             `(quote (repeat
1034                                      (list (regexp :tag "Group")
1035                                            ,(car (cdr parameter-type)))))))
1036          (variable-default (plist-get rest :variable-default)))
1037     (list
1038      'progn
1039      `(defcustom ,variable ,variable-default
1040         ,variable-document
1041         :group 'gnus-group-parameter
1042         :group ',variable-group
1043         :type ,variable-type)
1044      `(setq gnus-group-parameters-more
1045             (delq (assq ',param gnus-group-parameters-more)
1046                   gnus-group-parameters-more))
1047      `(add-to-list 'gnus-group-parameters-more
1048                    (list ',param
1049                          ,parameter-type
1050                          ,parameter-document))
1051      (if (eq type 'bool)
1052          `(defun ,function (name)
1053             ,function-document
1054             (let ((params (gnus-group-find-parameter name))
1055                   val)
1056               (cond
1057                ((memq ',param params)
1058                 t)
1059                ((setq val (assq ',param params))
1060                 (cdr val))
1061                ((stringp ,variable)
1062                 (string-match ,variable name))
1063                (,variable
1064                 (let ((alist ,variable)
1065                       elem value)
1066                   (while (setq elem (pop alist))
1067                     (when (and name
1068                                (string-match (car elem) name))
1069                       (setq alist nil
1070                             value (cdr elem))))
1071                   (if (consp value) (car value) value))))))
1072        `(defun ,function (name)
1073           ,function-document
1074           (and name
1075                (or (gnus-group-find-parameter name ',param ,(and type t))
1076                    (let ((alist ,variable)
1077                          elem value)
1078                      (while (setq elem (pop alist))
1079                        (when (and name
1080                                   (string-match (car elem) name))
1081                          (setq alist nil
1082                                value (cdr elem))))
1083                      ,(if type
1084                           'value
1085                         '(if (consp value) (car value) value))))))))))
1086
1087 (defcustom gnus-home-directory "~/"
1088   "Directory variable that specifies the \"home\" directory.
1089 All other Gnus file and directory variables are initialized from this variable."
1090   :group 'gnus-files
1091   :type 'directory)
1092
1093 (defcustom gnus-directory (or (getenv "SAVEDIR")
1094                               (nnheader-concat gnus-home-directory "News/"))
1095   "*Directory variable from which all other Gnus file variables are derived.
1096
1097 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1098 This means that other directory variables that are initialized from
1099 this variable won't be set properly if you set this variable in `.gnus.el'.
1100 Set this variable in `.emacs' instead."
1101   :group 'gnus-files
1102   :type 'directory)
1103
1104 (defcustom gnus-default-directory nil
1105   "*Default directory for all Gnus buffers."
1106   :group 'gnus-files
1107   :type '(choice (const :tag "current" nil)
1108                  directory))
1109
1110 ;; Site dependent variables.  These variables should be defined in
1111 ;; paths.el.
1112
1113 (defvar gnus-default-nntp-server nil
1114   "Specify a default NNTP server.
1115 This variable should be defined in paths.el, and should never be set
1116 by the user.
1117 If you want to change servers, you should use `gnus-select-method'.
1118 See the documentation to that variable.")
1119
1120 ;; Don't touch this variable.
1121 (defvar gnus-nntp-service "nntp"
1122   "NNTP service name (\"nntp\" or 119).
1123 This is an obsolete variable, which is scarcely used.  If you use an
1124 nntp server for your newsgroup and want to change the port number
1125 used to 899, you would say something along these lines:
1126
1127  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1128
1129 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1130   "A file with only the name of the nntp server in it."
1131   :group 'gnus-files
1132   :group 'gnus-server
1133   :type 'file)
1134
1135 (defun gnus-getenv-nntpserver ()
1136   "Find default nntp server.
1137 Check the NNTPSERVER environment variable and the
1138 `gnus-nntpserver-file' file."
1139   (or (getenv "NNTPSERVER")
1140       (and (file-readable-p gnus-nntpserver-file)
1141            (with-temp-buffer
1142              (insert-file-contents gnus-nntpserver-file)
1143              (let ((name (buffer-string)))
1144                (unless (string-match "\\`[ \t\n]*$" name)
1145                  name))))))
1146
1147 (defcustom gnus-select-method
1148   (condition-case nil
1149       (nconc
1150        (list 'nntp (or (condition-case nil
1151                            (gnus-getenv-nntpserver)
1152                          (error nil))
1153                        (when (and gnus-default-nntp-server
1154                                   (not (string= gnus-default-nntp-server "")))
1155                          gnus-default-nntp-server)
1156                        "news"))
1157        (if (or (null gnus-nntp-service)
1158                (equal gnus-nntp-service "nntp"))
1159            nil
1160          (list gnus-nntp-service)))
1161     (error nil))
1162   "Default method for selecting a newsgroup.
1163 This variable should be a list, where the first element is how the
1164 news is to be fetched, the second is the address.
1165
1166 For instance, if you want to get your news via \"flab.flab.edu\" using
1167 NNTP, you could say:
1168
1169 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1170
1171 If you want to use your local spool, say:
1172
1173 \(setq gnus-select-method (list 'nnspool (system-name)))
1174
1175 If you use this variable, you must set `gnus-nntp-server' to nil.
1176
1177 There is a lot more to know about select methods and virtual servers -
1178 see the manual for details."
1179   :group 'gnus-server
1180   :type 'gnus-select-method)
1181
1182 (defcustom gnus-message-archive-method "archive"
1183   "*Method used for archiving messages you've sent.
1184 This should be a mail method."
1185   :group 'gnus-server
1186   :group 'gnus-message
1187   :type '(choice (const :tag "Default archive method" "archive")
1188                  gnus-select-method))
1189
1190 (defcustom gnus-message-archive-group nil
1191   "*Name of the group in which to save the messages you've written.
1192 This can either be a string; a list of strings; or an alist
1193 of regexps/functions/forms to be evaluated to return a string (or a list
1194 of strings).  The functions are called with the name of the current
1195 group (or nil) as a parameter.
1196
1197 If you want to save your mail in one group and the news articles you
1198 write in another group, you could say something like:
1199
1200  \(setq gnus-message-archive-group
1201         '((if (message-news-p)
1202               \"misc-news\"
1203             \"misc-mail\")))
1204
1205 Normally the group names returned by this variable should be
1206 unprefixed -- which implicitly means \"store on the archive server\".
1207 However, you may wish to store the message on some other server.  In
1208 that case, just return a fully prefixed name of the group --
1209 \"nnml+private:mail.misc\", for instance."
1210   :group 'gnus-message
1211   :type '(choice (const :tag "none" nil)
1212                  function
1213                  sexp
1214                  string))
1215
1216 (defcustom gnus-secondary-servers nil
1217   "List of NNTP servers that the user can choose between interactively.
1218 To make Gnus query you for a server, you have to give `gnus' a
1219 non-numeric prefix - `C-u M-x gnus', in short."
1220   :group 'gnus-server
1221   :type '(repeat string))
1222
1223 (defcustom gnus-nntp-server nil
1224   "*The name of the host running the NNTP server.
1225 This variable is semi-obsolete.  Use the `gnus-select-method'
1226 variable instead."
1227   :group 'gnus-server
1228   :type '(choice (const :tag "disable" nil)
1229                  string))
1230
1231 (defcustom gnus-secondary-select-methods nil
1232   "A list of secondary methods that will be used for reading news.
1233 This is a list where each element is a complete select method (see
1234 `gnus-select-method').
1235
1236 If, for instance, you want to read your mail with the nnml back end,
1237 you could set this variable:
1238
1239 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1240   :group 'gnus-server
1241   :type '(repeat gnus-select-method))
1242
1243 (defvar gnus-backup-default-subscribed-newsgroups
1244   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1245   "Default default new newsgroups the first time Gnus is run.
1246 Should be set in paths.el, and shouldn't be touched by the user.")
1247
1248 (defcustom gnus-local-domain nil
1249   "Local domain name without a host name.
1250 The DOMAINNAME environment variable is used instead if it is defined.
1251 If the function `system-name' returns the full Internet name, there is
1252 no need to set this variable."
1253   :group 'gnus-message
1254   :type '(choice (const :tag "default" nil)
1255                  string))
1256
1257 (defvar gnus-local-organization nil
1258   "String with a description of what organization (if any) the user belongs to.
1259 Obsolete variable; use `message-user-organization' instead.")
1260
1261 ;; Customization variables
1262
1263 (defcustom gnus-refer-article-method nil
1264   "Preferred method for fetching an article by Message-ID.
1265 If you are reading news from the local spool (with nnspool), fetching
1266 articles by Message-ID is painfully slow.  By setting this method to an
1267 nntp method, you might get acceptable results.
1268
1269 The value of this variable must be a valid select method as discussed
1270 in the documentation of `gnus-select-method'.
1271
1272 It can also be a list of select methods, as well as the special symbol
1273 `current', which means to use the current select method.  If it is a
1274 list, Gnus will try all the methods in the list until it finds a match."
1275   :group 'gnus-server
1276   :type '(choice (const :tag "default" nil)
1277                  (const current)
1278                  (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1279                  gnus-select-method
1280                  (repeat :menu-tag "Try multiple"
1281                          :tag "Multiple"
1282                          :value (current (nnweb "refer" (nnweb-type google)))
1283                          (choice :tag "Method"
1284                                  (const current)
1285                                  (const :tag "Google"
1286                                         (nnweb "refer" (nnweb-type google)))
1287                                  gnus-select-method))))
1288
1289 (defcustom gnus-group-faq-directory
1290   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1291     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1292     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1293     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1294     "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1295     "/ftp@rtfm.mit.edu:/pub/usenet/"
1296     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1297     "/ftp@ftp.sunet.se:/pub/usenet/"
1298     "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1299     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1300     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1301   "*Directory where the group FAQs are stored.
1302 This will most commonly be on a remote machine, and the file will be
1303 fetched by ange-ftp.
1304
1305 This variable can also be a list of directories.  In that case, the
1306 first element in the list will be used by default.  The others can
1307 be used when being prompted for a site.
1308
1309 Note that Gnus uses an aol machine as the default directory.  If this
1310 feels fundamentally unclean, just think of it as a way to finally get
1311 something of value back from them.
1312
1313 If the default site is too slow, try one of these:
1314
1315    North America: mirrors.aol.com                /pub/rtfm/usenet
1316                   ftp.seas.gwu.edu               /pub/rtfm
1317                   rtfm.mit.edu                   /pub/usenet
1318    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1319                   src.doc.ic.ac.uk               /usenet/news-FAQS
1320                   ftp.sunet.se                   /pub/usenet
1321                   ftp.pasteur.fr                 /pub/FAQ
1322    Asia:          nctuccca.nctu.edu.tw           /pub/Documents/rtfm/usenet-by-group/
1323                   hwarang.postech.ac.kr          /pub/usenet
1324                   ftp.hk.super.net               /mirror/faqs"
1325   :group 'gnus-group-various
1326   :type '(choice directory
1327                  (repeat directory)))
1328
1329 (defcustom gnus-group-charter-alist
1330   '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1331     ("de" . (concat "http://purl.net/charta/" name ".html"))
1332     ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1333     ("england" . (concat "http://england.news-admin.org/charters/" name))
1334     ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1335     ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1336                         (gnus-replace-in-string name "europa\\." "") ".html"))
1337     ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1338     ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1339     ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1340     ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1341     ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1342     ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1343     ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1344     ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1345                     (gnus-replace-in-string name "\\." "_") ".html"))
1346     ("milw" . (concat "http://usenet.mil.wi.us/"
1347                       (gnus-replace-in-string name "milw\\." "") "-charter"))
1348     ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1349     ("netins" . (concat "http://www.netins.net/usenet/charter/"
1350                         (gnus-replace-in-string name "\\." "-") "-charter.html")))
1351   "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1352 When FORM is evaluated `name' is bound to the name of the group."
1353   :group 'gnus-group-various
1354   :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1355
1356 (defcustom gnus-group-fetch-control-use-browse-url nil
1357   "*Non-nil means that control messages are displayed using `browse-url'.
1358 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1359 group."
1360   :group 'gnus-group-various
1361   :type 'boolean)
1362
1363 (defcustom gnus-use-cross-reference t
1364   "*Non-nil means that cross referenced articles will be marked as read.
1365 If nil, ignore cross references.  If t, mark articles as read in
1366 subscribed newsgroups.  If neither t nor nil, mark as read in all
1367 newsgroups."
1368   :group 'gnus-server
1369   :type '(choice (const :tag "off" nil)
1370                  (const :tag "subscribed" t)
1371                  (sexp :format "all"
1372                        :value always)))
1373
1374 (defcustom gnus-process-mark ?#
1375   "*Process mark."
1376   :group 'gnus-group-visual
1377   :group 'gnus-summary-marks
1378   :type 'character)
1379
1380 (defcustom gnus-large-newsgroup 200
1381   "*The number of articles which indicates a large newsgroup.
1382 If the number of articles in a newsgroup is greater than this value,
1383 confirmation is required for selecting the newsgroup.
1384 If it is nil, no confirmation is required."
1385   :group 'gnus-group-select
1386   :type '(choice (const :tag "No limit" nil)
1387                  integer))
1388
1389 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1390   "*Non-nil means that the default name of a file to save articles in is the group name.
1391 If it's nil, the directory form of the group name is used instead.
1392
1393 If this variable is a list, and the list contains the element
1394 `not-score', long file names will not be used for score files; if it
1395 contains the element `not-save', long file names will not be used for
1396 saving; and if it contains the element `not-kill', long file names
1397 will not be used for kill files.
1398
1399 Note that the default for this variable varies according to what system
1400 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1401 to nil while on all other systems it defaults to t."
1402   :group 'gnus-start
1403   :type '(radio (sexp :format "Non-nil\n"
1404                       :match (lambda (widget value)
1405                                (and value (not (listp value))))
1406                       :value t)
1407                 (const nil)
1408                 (checklist (const :format "%v " not-score)
1409                            (const :format "%v " not-save)
1410                            (const not-kill))))
1411
1412 (defcustom gnus-kill-files-directory gnus-directory
1413   "*Name of the directory where kill files will be stored (default \"~/News\")."
1414   :group 'gnus-score-files
1415   :group 'gnus-score-kill
1416   :type 'directory)
1417
1418 (defcustom gnus-save-score nil
1419   "*If non-nil, save group scoring info."
1420   :group 'gnus-score-various
1421   :group 'gnus-start
1422   :type 'boolean)
1423
1424 (defcustom gnus-use-undo t
1425   "*If non-nil, allow undoing in Gnus group mode buffers."
1426   :group 'gnus-meta
1427   :type 'boolean)
1428
1429 (defcustom gnus-use-adaptive-scoring nil
1430   "*If non-nil, use some adaptive scoring scheme.
1431 If a list, then the values `word' and `line' are meaningful.  The
1432 former will perform adaption on individual words in the subject
1433 header while `line' will perform adaption on several headers."
1434   :group 'gnus-meta
1435   :group 'gnus-score-adapt
1436   :type '(set (const word) (const line)))
1437
1438 (defcustom gnus-use-cache 'passive
1439   "*If nil, Gnus will ignore the article cache.
1440 If `passive', it will allow entering (and reading) articles
1441 explicitly entered into the cache.  If anything else, use the
1442 cache to the full extent of the law."
1443   :group 'gnus-meta
1444   :group 'gnus-cache
1445   :type '(choice (const :tag "off" nil)
1446                  (const :tag "passive" passive)
1447                  (const :tag "active" t)))
1448
1449 (defcustom gnus-use-trees nil
1450   "*If non-nil, display a thread tree buffer."
1451   :group 'gnus-meta
1452   :type 'boolean)
1453
1454 (defcustom gnus-use-grouplens nil
1455   "*If non-nil, use GroupLens ratings."
1456   :group 'gnus-meta
1457   :type 'boolean)
1458
1459 (defcustom gnus-keep-backlog 20
1460   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1461 If it is a number N, then Gnus will only keep the last N articles
1462 read.  If it is neither nil nor a number, Gnus will keep all read
1463 articles.  This is not a good idea."
1464   :group 'gnus-meta
1465   :type '(choice (const :tag "off" nil)
1466                  integer
1467                  (sexp :format "all"
1468                        :value t)))
1469
1470 (defcustom gnus-use-nocem nil
1471   "*If non-nil, Gnus will read NoCeM cancel messages."
1472   :group 'gnus-meta
1473   :type 'boolean)
1474
1475 (defcustom gnus-suppress-duplicates nil
1476   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1477   :group 'gnus-meta
1478   :type 'boolean)
1479
1480 (defcustom gnus-use-scoring t
1481   "*If non-nil, enable scoring."
1482   :group 'gnus-meta
1483   :type 'boolean)
1484
1485 (defcustom gnus-summary-prepare-exit-hook
1486   '(gnus-summary-expire-articles)
1487   "*A hook called when preparing to exit from the summary buffer.
1488 It calls `gnus-summary-expire-articles' by default."
1489   :group 'gnus-summary-exit
1490   :type 'hook)
1491
1492 (defcustom gnus-novice-user t
1493   "*Non-nil means that you are a Usenet novice.
1494 If non-nil, verbose messages may be displayed and confirmations may be
1495 required."
1496   :group 'gnus-meta
1497   :type 'boolean)
1498
1499 (defcustom gnus-expert-user nil
1500   "*Non-nil means that you will never be asked for confirmation about anything.
1501 That doesn't mean *anything* anything; particularly destructive
1502 commands will still require prompting."
1503   :group 'gnus-meta
1504   :type 'boolean)
1505
1506 (defcustom gnus-interactive-catchup t
1507   "*If non-nil, require your confirmation when catching up a group."
1508   :group 'gnus-group-select
1509   :type 'boolean)
1510
1511 (defcustom gnus-interactive-exit t
1512   "*If non-nil, require your confirmation when exiting Gnus."
1513   :group 'gnus-exit
1514   :type 'boolean)
1515
1516 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1517   "Function for extracting address components from a From header.
1518 Three pre-defined functions exist: `gnus-extract-address-components',
1519 which is the default, quite fast, and too simplistic solution,
1520 `mail-extract-address-components', which works much better, but is
1521 slower, and `std11-extract-address-components'."
1522   :group 'gnus-summary-format
1523   :type '(radio (function-item gnus-extract-address-components)
1524                 (function-item mail-extract-address-components)
1525                 (function-item std11-extract-address-components)
1526                 (function :tag "Other")))
1527
1528 (defcustom gnus-carpal nil
1529   "*If non-nil, display clickable icons."
1530   :group 'gnus-meta
1531   :type 'boolean)
1532
1533 (defcustom gnus-shell-command-separator ";"
1534   "String used to separate shell commands."
1535   :group 'gnus-files
1536   :type 'string)
1537
1538 (defcustom gnus-valid-select-methods
1539   '(("nntp" post address prompt-address physical-address)
1540     ("nnspool" post address)
1541     ("nnvirtual" post-mail virtual prompt-address)
1542     ("nnmbox" mail respool address)
1543     ("nnml" post-mail respool address)
1544     ("nnmh" mail respool address)
1545     ("nndir" post-mail prompt-address physical-address)
1546     ("nneething" none address prompt-address physical-address)
1547     ("nndoc" none address prompt-address)
1548     ("nnbabyl" mail address respool)
1549     ("nnkiboze" post virtual)
1550     ("nnsoup" post-mail address)
1551     ("nndraft" post-mail)
1552     ("nnfolder" mail respool address)
1553     ("nngateway" post-mail address prompt-address physical-address)
1554     ("nnweb" none)
1555     ("nngoogle" post)
1556     ("nnslashdot" post)
1557     ("nnultimate" none)
1558     ("nnrss" none)
1559     ("nnwfm" none)
1560     ("nnwarchive" none)
1561     ("nnlistserv" none)
1562     ("nnagent" post-mail)
1563     ("nnimap" post-mail address prompt-address physical-address)
1564     ("nnmaildir" mail respool address)
1565     ("nnnil" none))
1566   "*An alist of valid select methods.
1567 The first element of each list lists should be a string with the name
1568 of the select method.  The other elements may be the category of
1569 this method (i. e., `post', `mail', `none' or whatever) or other
1570 properties that this method has (like being respoolable).
1571 If you implement a new select method, all you should have to change is
1572 this variable.  I think."
1573   :group 'gnus-server
1574   :type '(repeat (group (string :tag "Name")
1575                         (radio-button-choice (const :format "%v " post)
1576                                              (const :format "%v " mail)
1577                                              (const :format "%v " none)
1578                                              (const post-mail))
1579                         (checklist :inline t
1580                                    (const :format "%v " address)
1581                                    (const :format "%v " prompt-address)
1582                                    (const :format "%v " physical-address)
1583                                    (const :format "%v " virtual)
1584                                    (const respool)))))
1585
1586 (defun gnus-redefine-select-method-widget ()
1587   "Recomputes the select-method widget based on the value of
1588 `gnus-valid-select-methods'."
1589   (define-widget 'gnus-select-method 'list
1590     "Widget for entering a select method."
1591     :value '(nntp "")
1592     :tag "Select Method"
1593     :args `((choice :tag "Method"
1594                     ,@(mapcar (lambda (entry)
1595                                 (list 'const :format "%v\n"
1596                                       (intern (car entry))))
1597                               gnus-valid-select-methods)
1598                     (symbol :tag "other"))
1599             (string :tag "Address")
1600             (repeat :tag "Options"
1601                     :inline t
1602                     (list :format "%v"
1603                           variable
1604                           (sexp :tag "Value"))))))
1605
1606 (gnus-redefine-select-method-widget)
1607
1608 (defcustom gnus-updated-mode-lines '(group article summary tree)
1609   "List of buffers that should update their mode lines.
1610 The list may contain the symbols `group', `article', `tree' and
1611 `summary'.  If the corresponding symbol is present, Gnus will keep
1612 that mode line updated with information that may be pertinent.
1613 If this variable is nil, screen refresh may be quicker."
1614   :group 'gnus-various
1615   :type '(set (const group)
1616               (const article)
1617               (const summary)
1618               (const tree)))
1619
1620 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1621 (defcustom gnus-mode-non-string-length nil
1622   "*Max length of mode-line non-string contents.
1623 If this is nil, Gnus will take space as is needed, leaving the rest
1624 of the mode line intact.  Note that the default of nil is unlikely
1625 to be desirable; see the manual for further details."
1626   :group 'gnus-various
1627   :type '(choice (const nil)
1628                  integer))
1629
1630 ;; There should be special validation for this.
1631 (define-widget 'gnus-email-address 'string
1632   "An email address.")
1633
1634 (gnus-define-group-parameter
1635  to-address
1636  :function-document
1637  "Return GROUP's to-address."
1638  :variable-document
1639  "*Alist of group regexps and correspondent to-addresses."
1640  :parameter-type '(gnus-email-address :tag "To Address")
1641  :parameter-document "\
1642 This will be used when doing followups and posts.
1643
1644 This is primarily useful in mail groups that represent closed
1645 mailing lists--mailing lists where it's expected that everybody that
1646 writes to the mailing list is subscribed to it.  Since using this
1647 parameter ensures that the mail only goes to the mailing list itself,
1648 it means that members won't receive two copies of your followups.
1649
1650 Using `to-address' will actually work whether the group is foreign or
1651 not.  Let's say there's a group on the server that is called
1652 `fa.4ad-l'.  This is a real newsgroup, but the server has gotten the
1653 articles from a mail-to-news gateway.  Posting directly to this group
1654 is therefore impossible--you have to send mail to the mailing list
1655 address instead.
1656
1657 The gnus-group-split mail splitting mechanism will behave as if this
1658 address was listed in gnus-group-split Addresses (see below).")
1659
1660 (gnus-define-group-parameter
1661  to-list
1662  :function-document
1663  "Return GROUP's to-list."
1664  :variable-document
1665  "*Alist of group regexps and correspondent to-lists."
1666  :parameter-type '(gnus-email-address :tag "To List")
1667  :parameter-document "\
1668 This address will be used when doing a `a' in the group.
1669
1670 It is totally ignored when doing a followup--except that if it is
1671 present in a news group, you'll get mail group semantics when doing
1672 `f'.
1673
1674 The gnus-group-split mail splitting mechanism will behave as if this
1675 address was listed in gnus-group-split Addresses (see below).")
1676
1677 (gnus-define-group-parameter
1678  subscribed
1679  :type bool
1680  :function-document
1681  "Return GROUP's subscription status."
1682  :variable-document
1683  "*Groups which are automatically considered subscribed."
1684  :parameter-type '(const :tag "Subscribed" t)
1685  :parameter-document "\
1686 Gnus assumed that you are subscribed to the To/List address.
1687
1688 When constructing a list of subscribed groups using
1689 `gnus-find-subscribed-addresses', Gnus includes the To address given
1690 above, or the list address (if the To address has not been set).")
1691
1692 (gnus-define-group-parameter
1693  auto-expire
1694  :type bool
1695  :function gnus-group-auto-expirable-p
1696  :function-document
1697  "Check whether GROUP is auto-expirable or not."
1698  :variable gnus-auto-expirable-newsgroups
1699  :variable-default nil
1700  :variable-document
1701  "*Groups in which to automatically mark read articles as expirable.
1702 If non-nil, this should be a regexp that should match all groups in
1703 which to perform auto-expiry.  This only makes sense for mail groups."
1704  :variable-group nnmail-expire
1705  :variable-type '(choice (const nil)
1706                          regexp)
1707  :parameter-type '(const :tag "Automatic Expire" t)
1708  :parameter-document
1709  "All articles that are read will be marked as expirable.")
1710
1711 (gnus-define-group-parameter
1712  total-expire
1713  :type bool
1714  :function gnus-group-total-expirable-p
1715  :function-document
1716  "Check whether GROUP is total-expirable or not."
1717  :variable gnus-total-expirable-newsgroups
1718  :variable-default nil
1719  :variable-document
1720  "*Groups in which to perform expiry of all read articles.
1721 Use with extreme caution.  All groups that match this regexp will be
1722 expiring - which means that all read articles will be deleted after
1723 \(say) one week.         (This only goes for mail groups and the like, of
1724 course.)"
1725  :variable-group nnmail-expire
1726  :variable-type '(choice (const nil)
1727                          regexp)
1728  :parameter-type '(const :tag "Total Expire" t)
1729  :parameter-document
1730  "All read articles will be put through the expiry process
1731
1732 This happens even if they are not marked as expirable.
1733 Use with caution.")
1734
1735 (gnus-define-group-parameter
1736  charset
1737  :function-document
1738  "Return the default charset of GROUP."
1739  :variable gnus-group-charset-alist
1740  :variable-default
1741  '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1742    ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1743    ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1744    ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1745    ("\\(^\\|:\\)relcom\\>" koi8-r)
1746    ("\\(^\\|:\\)fido7\\>" koi8-r)
1747    ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1748    ("\\(^\\|:\\)israel\\>" iso-8859-1)
1749    ("\\(^\\|:\\)han\\>" euc-kr)
1750    ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1751    ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1752    ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1753  :variable-document
1754  "Alist of regexps (to match group names) and default charsets to be used when reading."
1755  :variable-group gnus-charset
1756  :variable-type '(repeat (list (regexp :tag "Group")
1757                                (symbol :tag "Charset")))
1758  :parameter-type '(symbol :tag "Charset")
1759  :parameter-document "\
1760 The default charset to use in the group.")
1761
1762 (gnus-define-group-parameter
1763  post-method
1764  :type list
1765  :function-document
1766  "Return a posting method for GROUP."
1767  :variable gnus-post-method-alist
1768  :variable-document
1769  "Alist of regexps (to match group names) and method to be used when
1770 posting an article."
1771  :variable-group gnus-group-foreign
1772  :parameter-type
1773  '(choice :tag "Posting Method"
1774           (const :tag "Use native server" native)
1775           (const :tag "Use current server" current)
1776           (list :convert-widget
1777                 (lambda (widget)
1778                   (list 'sexp :tag "Methods"
1779                         :value gnus-select-method))))
1780  :parameter-document
1781  "Posting method for this group.")
1782
1783 (gnus-define-group-parameter
1784  large-newsgroup-initial
1785  :type integer
1786  :function-document
1787  "Return GROUP's initial input of the number of articles."
1788  :variable-document
1789  "*Alist of group regexps and its initial input of the number of articles."
1790  :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1791                           (const :tag "All" nil)
1792                           (integer))
1793  :parameter-document "\
1794
1795 This number will be prompted as the initial value of the number of
1796 articles to list when the group is a large newsgroup (see
1797 `gnus-large-newsgroup').  If it is nil, the default value is the
1798 total number of articles in the group.")
1799
1800 ;; The Gnus registry's ignored groups
1801 (gnus-define-group-parameter
1802  registry-ignore
1803  :type list
1804  :function-document
1805  "Whether this group should be ignored by the registry."
1806  :variable gnus-registry-ignored-groups
1807  :variable-default nil
1808  :variable-document
1809  "*Groups in which the registry should be turned off."
1810  :variable-group gnus-registry
1811  :variable-type '(repeat
1812                   (list
1813                    (regexp :tag "Group Name Regular Expression")
1814                    (boolean :tag "Ignored")))
1815
1816  :parameter-type '(boolean :tag "Group Ignored by the Registry")
1817  :parameter-document
1818  "Whether the Gnus Registry should ignore this group.")
1819
1820 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1821 (defcustom gnus-install-group-spam-parameters t
1822   "*Disable the group parameters for spam detection.
1823 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1824   :type 'boolean
1825   :group 'gnus-start)
1826
1827 (when gnus-install-group-spam-parameters
1828   (defvar gnus-group-spam-classification-spam t
1829     "Spam group classification (requires spam.el).
1830 This group contains spam messages.  On summary entry, unread messages
1831 will be marked as spam.  On summary exit, the specified spam
1832 processors will be invoked on spam-marked messages, then those
1833 messages will be expired, so the spam processor will only see a
1834 spam-marked message once.")
1835
1836   (defvar gnus-group-spam-classification-ham 'ask
1837     "The ham value for the spam group parameter (requires spam.el).
1838 On summary exit, the specified ham processors will be invoked on
1839 ham-marked messages.  Exercise caution, since the ham processor will
1840 see the same message more than once because there is no ham message
1841 registry.")
1842
1843   (gnus-define-group-parameter
1844    spam-contents
1845    :type list
1846    :function-document
1847    "The spam type (spam, ham, or neither) of the group."
1848    :variable gnus-spam-newsgroup-contents
1849    :variable-default nil
1850    :variable-document
1851    "*Groups in which to automatically mark new articles as spam on
1852 summary entry.  If non-nil, this should be a list of group name
1853 regexps that should match all groups in which to do automatic spam
1854 tagging, associated with a classification (spam, ham, or neither).
1855 This only makes sense for mail groups."
1856    :variable-group spam
1857    :variable-type '(repeat
1858                     (list :tag "Group contents spam/ham classification"
1859                           (regexp :tag "Group")
1860                           (choice
1861                            (variable-item gnus-group-spam-classification-spam)
1862                            (variable-item gnus-group-spam-classification-ham)
1863                            (const :tag "Unclassified" nil))))
1864
1865    :parameter-type '(list :tag "Group contents spam/ham classification"
1866                           (choice :tag "Group contents classification for spam sorting"
1867                                   (variable-item gnus-group-spam-classification-spam)
1868                                   (variable-item gnus-group-spam-classification-ham)
1869                                   (const :tag "Unclassified" nil)))
1870    :parameter-document
1871    "The spam classification (spam, ham, or neither) of this group.
1872 When a spam group is entered, all unread articles are marked as spam.")
1873
1874   (defvar gnus-group-spam-exit-processor-ifile "ifile"
1875     "OBSOLETE: The ifile summary exit spam processor.")
1876
1877   (defvar gnus-group-spam-exit-processor-stat "stat"
1878     "OBSOLETE: The spam-stat summary exit spam processor.")
1879
1880   (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1881     "OBSOLETE: The Bogofilter summary exit spam processor.")
1882
1883   (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1884     "OBSOLETE: The Blacklist summary exit spam processor.")
1885
1886   (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1887     "OBSOLETE: The Gmane reporting summary exit spam processor.
1888 Only applicable to NNTP groups with articles from Gmane.  See spam-report.el")
1889
1890   (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1891     "OBSOLETE: The spamoracle summary exit spam processor.")
1892
1893   (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1894     "OBSOLETE: The ifile summary exit ham processor.
1895 Only applicable to non-spam (unclassified and ham) groups.")
1896
1897   (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1898     "OBSOLETE: The Bogofilter summary exit ham processor.
1899 Only applicable to non-spam (unclassified and ham) groups.")
1900
1901   (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1902     "OBSOLETE: The spam-stat summary exit ham processor.
1903 Only applicable to non-spam (unclassified and ham) groups.")
1904
1905   (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1906     "OBSOLETE: The whitelist summary exit ham processor.
1907 Only applicable to non-spam (unclassified and ham) groups.")
1908
1909   (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1910     "OBSOLETE: The BBDB summary exit ham processor.
1911 Only applicable to non-spam (unclassified and ham) groups.")
1912
1913   (defvar gnus-group-ham-exit-processor-copy "copy"
1914     "OBSOLETE: The ham copy exit ham processor.
1915 Only applicable to non-spam (unclassified and ham) groups.")
1916
1917   (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1918     "OBSOLETE: The spamoracle summary exit ham processor.
1919 Only applicable to non-spam (unclassified and ham) groups.")
1920
1921   (gnus-define-group-parameter
1922    spam-process
1923    :type list
1924    :parameter-type
1925    '(choice
1926      :tag "Spam Summary Exit Processor"
1927      :value nil
1928      (list :tag "Spam Summary Exit Processor Choices"
1929            (set
1930             (variable-item gnus-group-spam-exit-processor-ifile)
1931             (variable-item gnus-group-spam-exit-processor-stat)
1932             (variable-item gnus-group-spam-exit-processor-bogofilter)
1933             (variable-item gnus-group-spam-exit-processor-blacklist)
1934             (variable-item gnus-group-spam-exit-processor-spamoracle)
1935             (variable-item gnus-group-spam-exit-processor-report-gmane)
1936             (variable-item gnus-group-ham-exit-processor-bogofilter)
1937             (variable-item gnus-group-ham-exit-processor-ifile)
1938             (variable-item gnus-group-ham-exit-processor-stat)
1939             (variable-item gnus-group-ham-exit-processor-whitelist)
1940             (variable-item gnus-group-ham-exit-processor-BBDB)
1941             (variable-item gnus-group-ham-exit-processor-spamoracle)
1942             (variable-item gnus-group-ham-exit-processor-copy)
1943             (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
1944             (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
1945             (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
1946             (const :tag "Spam: ifile"         (spam spam-use-ifile))
1947             (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
1948             (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
1949             (const :tag "Ham: ifile"          (ham spam-use-ifile))
1950             (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
1951             (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
1952             (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
1953             (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
1954             (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
1955             (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle)))))
1956    :function-document
1957    "Which spam or ham processors will be applied when the summary is exited."
1958    :variable gnus-spam-process-newsgroups
1959    :variable-default nil
1960    :variable-document
1961    "*Groups in which to automatically process spam or ham articles with
1962 a backend on summary exit.  If non-nil, this should be a list of group
1963 name regexps that should match all groups in which to do automatic
1964 spam processing, associated with the appropriate processor."
1965    :variable-group spam
1966    :variable-type
1967    '(repeat :tag "Spam/Ham Processors"
1968             (list :tag "Spam Summary Exit Processor Choices"
1969                   (regexp :tag "Group Regexp")
1970                   (set
1971                    :tag "Spam/Ham Summary Exit Processor"
1972                    (variable-item gnus-group-spam-exit-processor-ifile)
1973                    (variable-item gnus-group-spam-exit-processor-stat)
1974                    (variable-item gnus-group-spam-exit-processor-bogofilter)
1975                    (variable-item gnus-group-spam-exit-processor-blacklist)
1976                    (variable-item gnus-group-spam-exit-processor-spamoracle)
1977                    (variable-item gnus-group-spam-exit-processor-report-gmane)
1978                    (variable-item gnus-group-ham-exit-processor-bogofilter)
1979                    (variable-item gnus-group-ham-exit-processor-ifile)
1980                    (variable-item gnus-group-ham-exit-processor-stat)
1981                    (variable-item gnus-group-ham-exit-processor-whitelist)
1982                    (variable-item gnus-group-ham-exit-processor-BBDB)
1983                    (variable-item gnus-group-ham-exit-processor-spamoracle)
1984                    (variable-item gnus-group-ham-exit-processor-copy)
1985                    (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
1986                    (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
1987                    (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
1988                    (const :tag "Spam: ifile"         (spam spam-use-ifile))
1989                    (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
1990                    (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
1991                    (const :tag "Ham: ifile"          (ham spam-use-ifile))
1992                    (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
1993                    (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
1994                    (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
1995                    (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
1996                    (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
1997                    (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle)))))
1998
1999    :parameter-document
2000    "Which spam or ham processors will be applied when the summary is exited.")
2001
2002   (gnus-define-group-parameter
2003    spam-autodetect
2004    :type list
2005    :parameter-type
2006    '(boolean :tag "Spam autodetection")
2007    :function-document
2008    "Should spam be autodetected (with spam-split) in this group?"
2009    :variable gnus-spam-autodetect
2010    :variable-default nil
2011    :variable-document
2012    "*Groups in which spam should be autodetected when they are entered.
2013    Only unseen articles will be examined, unless
2014    spam-autodetect-recheck-messages is set."
2015    :variable-group spam
2016    :variable-type
2017    '(repeat
2018      :tag "Autodetection setting"
2019      (list
2020       (regexp :tag "Group Regexp")
2021       boolean))
2022    :parameter-document
2023    "Spam autodetection.
2024 Only unseen articles will be examined, unless
2025 spam-autodetect-recheck-messages is set.")
2026
2027   (gnus-define-group-parameter
2028    spam-autodetect-methods
2029    :type list
2030    :parameter-type
2031    '(choice :tag "Spam autodetection-specific methods"
2032      (const none)
2033      (const default)
2034      (set :tag "Use specific methods"
2035           (variable-item spam-use-blacklist)
2036           (variable-item spam-use-regex-headers)
2037           (variable-item spam-use-regex-body)
2038           (variable-item spam-use-whitelist)
2039           (variable-item spam-use-BBDB)
2040           (variable-item spam-use-ifile)
2041           (variable-item spam-use-spamoracle)
2042           (variable-item spam-use-stat)
2043           (variable-item spam-use-blackholes)
2044           (variable-item spam-use-hashcash)
2045           (variable-item spam-use-bogofilter-headers)
2046           (variable-item spam-use-bogofilter)))
2047    :function-document
2048    "Methods to be used for autodetection in each group"
2049    :variable gnus-spam-autodetect-methods
2050    :variable-default nil
2051    :variable-document
2052    "*Methods for autodetecting spam per group.
2053 Requires the spam-autodetect parameter.  Only unseen articles
2054 will be examined, unless spam-autodetect-recheck-messages is
2055 set."
2056    :variable-group spam
2057    :variable-type
2058    '(repeat
2059      :tag "Autodetection methods"
2060      (list
2061       (regexp :tag "Group Regexp")
2062       (choice
2063        (const none)
2064        (const default)
2065        (set :tag "Use specific methods"
2066         (variable-item spam-use-blacklist)
2067         (variable-item spam-use-regex-headers)
2068         (variable-item spam-use-regex-body)
2069         (variable-item spam-use-whitelist)
2070         (variable-item spam-use-BBDB)
2071         (variable-item spam-use-ifile)
2072         (variable-item spam-use-spamoracle)
2073         (variable-item spam-use-stat)
2074         (variable-item spam-use-blackholes)
2075         (variable-item spam-use-hashcash)
2076         (variable-item spam-use-bogofilter-headers)
2077         (variable-item spam-use-bogofilter)))))
2078      :parameter-document
2079    "Spam autodetection methods.
2080 Requires the spam-autodetect parameter.  Only unseen articles
2081 will be examined, unless spam-autodetect-recheck-messages is
2082 set.")
2083
2084   (gnus-define-group-parameter
2085    spam-process-destination
2086    :type list
2087    :parameter-type
2088    '(choice :tag "Destination for spam-processed articles at summary exit"
2089             (string :tag "Move to a group")
2090             (repeat :tag "Move to multiple groups"
2091                     (string :tag "Destination group"))
2092             (const :tag "Expire" nil))
2093    :function-document
2094    "Where spam-processed articles will go at summary exit."
2095    :variable gnus-spam-process-destinations
2096    :variable-default nil
2097    :variable-document
2098    "*Groups in which to explicitly send spam-processed articles to
2099 another group, or expire them (the default).  If non-nil, this should
2100 be a list of group name regexps that should match all groups in which
2101 to do spam-processed article moving, associated with the destination
2102 group or nil for explicit expiration.  This only makes sense for
2103 mail groups."
2104    :variable-group spam
2105    :variable-type
2106    '(repeat
2107      :tag "Spam-processed articles destination"
2108      (list
2109       (regexp :tag "Group Regexp")
2110       (choice
2111        :tag "Destination for spam-processed articles at summary exit"
2112        (string :tag "Move to a group")
2113        (repeat :tag "Move to multiple groups"
2114                (string :tag "Destination group"))
2115        (const :tag "Expire" nil))))
2116    :parameter-document
2117    "Where spam-processed articles will go at summary exit.")
2118
2119   (gnus-define-group-parameter
2120    ham-process-destination
2121    :type list
2122    :parameter-type
2123    '(choice
2124      :tag "Destination for ham articles at summary exit from a spam group"
2125      (string :tag "Move to a group")
2126      (repeat :tag "Move to multiple groups"
2127              (string :tag "Destination group"))
2128      (const :tag "Respool" respool)
2129      (const :tag "Do nothing" nil))
2130    :function-document
2131    "Where ham articles will go at summary exit from a spam group."
2132    :variable gnus-ham-process-destinations
2133    :variable-default nil
2134    :variable-document
2135    "*Groups in which to explicitly send ham articles to
2136 another group, or do nothing (the default).  If non-nil, this should
2137 be a list of group name regexps that should match all groups in which
2138 to do ham article moving, associated with the destination
2139 group or nil for explicit ignoring.  This only makes sense for
2140 mail groups, and only works in spam groups."
2141    :variable-group spam
2142    :variable-type
2143    '(repeat
2144      :tag "Ham articles destination"
2145      (list
2146       (regexp :tag "Group Regexp")
2147       (choice
2148        :tag "Destination for ham articles at summary exit from spam group"
2149        (string :tag "Move to a group")
2150        (repeat :tag "Move to multiple groups"
2151                 (string :tag "Destination group"))
2152        (const :tag "Respool" respool)
2153        (const :tag "Expire" nil))))
2154    :parameter-document
2155    "Where ham articles will go at summary exit from a spam group.")
2156
2157   (gnus-define-group-parameter
2158    ham-marks
2159    :type 'list
2160    :parameter-type '(list :tag "Ham mark choices"
2161                           (set
2162                            (variable-item gnus-del-mark)
2163                            (variable-item gnus-read-mark)
2164                            (variable-item gnus-ticked-mark)
2165                            (variable-item gnus-killed-mark)
2166                            (variable-item gnus-kill-file-mark)
2167                            (variable-item gnus-low-score-mark)))
2168
2169    :parameter-document
2170    "Marks considered ham (positively not spam).  Such articles will be
2171 processed as ham (non-spam) on group exit.  When nil, the global
2172 spam-ham-marks variable takes precedence."
2173    :variable-default '((".*" ((gnus-del-mark
2174                                gnus-read-mark
2175                                gnus-killed-mark
2176                                gnus-kill-file-mark
2177                                gnus-low-score-mark))))
2178    :variable-group spam
2179    :variable-document
2180    "*Groups in which to explicitly set the ham marks to some value.")
2181
2182   (gnus-define-group-parameter
2183    spam-marks
2184    :type 'list
2185    :parameter-type '(list :tag "Spam mark choices"
2186                           (set
2187                            (variable-item gnus-spam-mark)
2188                            (variable-item gnus-killed-mark)
2189                            (variable-item gnus-kill-file-mark)
2190                            (variable-item gnus-low-score-mark)))
2191
2192    :parameter-document
2193    "Marks considered spam.
2194 Such articles will be processed as spam on group exit.  When nil, the global
2195 spam-spam-marks variable takes precedence."
2196    :variable-default '((".*" ((gnus-spam-mark))))
2197    :variable-group spam
2198    :variable-document
2199    "*Groups in which to explicitly set the spam marks to some value."))
2200
2201 (defcustom gnus-group-uncollapsed-levels 1
2202   "Number of group name elements to leave alone when making a short group name."
2203   :group 'gnus-group-visual
2204   :type 'integer)
2205
2206 (defcustom gnus-group-use-permanent-levels nil
2207   "*If non-nil, once you set a level, Gnus will use this level."
2208   :group 'gnus-group-levels
2209   :type 'boolean)
2210
2211 ;; Hooks.
2212
2213 (defcustom gnus-load-hook nil
2214   "A hook run while Gnus is loaded."
2215   :group 'gnus-start
2216   :type 'hook)
2217
2218 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2219   "A hook called to apply kill files to a group.
2220 This hook is intended to apply a kill file to the selected newsgroup.
2221 The function `gnus-apply-kill-file' is called by default.
2222
2223 Since a general kill file is too heavy to use only for a few
2224 newsgroups, I recommend you to use a lighter hook function.  For
2225 example, if you'd like to apply a kill file to articles which contains
2226 a string `rmgroup' in subject in newsgroup `control', you can use the
2227 following hook:
2228
2229  (setq gnus-apply-kill-hook
2230       (list
2231         (lambda ()
2232           (cond ((string-match \"control\" gnus-newsgroup-name)
2233                  (gnus-kill \"Subject\" \"rmgroup\")
2234                  (gnus-expunge \"X\"))))))"
2235   :group 'gnus-score-kill
2236   :options '(gnus-apply-kill-file)
2237   :type 'hook)
2238
2239 (defcustom gnus-group-change-level-function nil
2240   "Function run when a group level is changed.
2241 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2242   :group 'gnus-group-levels
2243   :type 'function)
2244
2245 ;;; Face thingies.
2246
2247 (defcustom gnus-visual
2248   '(summary-highlight group-highlight article-highlight
2249                       mouse-face
2250                       summary-menu group-menu article-menu
2251                       tree-highlight menu highlight
2252                       browse-menu server-menu
2253                       page-marker tree-menu binary-menu pick-menu
2254                       grouplens-menu)
2255   "*Enable visual features.
2256 If `visual' is disabled, there will be no menus and few faces.  Most of
2257 the visual customization options below will be ignored.  Gnus will use
2258 less space and be faster as a result.
2259
2260 This variable can also be a list of visual elements to switch on.  For
2261 instance, to switch off all visual things except menus, you can say:
2262
2263    (setq gnus-visual '(menu))
2264
2265 Valid elements include `summary-highlight', `group-highlight',
2266 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2267 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2268 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
2269 and `grouplens-menu'."
2270   :group 'gnus-meta
2271   :group 'gnus-visual
2272   :type '(set (const summary-highlight)
2273               (const group-highlight)
2274               (const article-highlight)
2275               (const mouse-face)
2276               (const summary-menu)
2277               (const group-menu)
2278               (const article-menu)
2279               (const tree-highlight)
2280               (const menu)
2281               (const highlight)
2282               (const browse-menu)
2283               (const server-menu)
2284               (const page-marker)
2285               (const tree-menu)
2286               (const binary-menu)
2287               (const pick-menu)
2288               (const grouplens-menu)))
2289
2290 ;; Byte-compiler warning.
2291 (defvar gnus-visual)
2292 ;; Find out whether the gnus-visual TYPE is wanted.
2293 (defun gnus-visual-p (&optional type class)
2294   (and gnus-visual                      ; Has to be non-nil, at least.
2295        (if (not type)                   ; We don't care about type.
2296            gnus-visual
2297          (if (listp gnus-visual)        ; It's a list, so we check it.
2298              (or (memq type gnus-visual)
2299                  (memq class gnus-visual))
2300            t))))
2301
2302 (defcustom gnus-mouse-face
2303   (condition-case ()
2304       (if (gnus-visual-p 'mouse-face 'highlight)
2305           (if (boundp 'gnus-mouse-face)
2306               (or gnus-mouse-face 'highlight)
2307             'highlight)
2308         'default)
2309     (error 'highlight))
2310   "*Face used for group or summary buffer mouse highlighting.
2311 The line beneath the mouse pointer will be highlighted with this
2312 face."
2313   :group 'gnus-visual
2314   :type 'face)
2315
2316 (defcustom gnus-article-save-directory gnus-directory
2317   "*Name of the directory articles will be saved in (default \"~/News\")."
2318   :group 'gnus-article-saving
2319   :type 'directory)
2320
2321 (defvar gnus-plugged t
2322   "Whether Gnus is plugged or not.")
2323
2324 (defcustom gnus-agent-cache t
2325   "Controls use of the agent cache while plugged.
2326 When set, Gnus will prefer using the locally stored content rather
2327 than re-fetching it from the server.  You also need to enable
2328 `gnus-agent' for this to have any affect."
2329   :version "21.3"
2330   :group 'gnus-agent
2331   :type 'boolean)
2332
2333 (defcustom gnus-default-charset 'undecided
2334   "Default charset assumed to be used when viewing non-ASCII characters.
2335 This variable is overridden on a group-to-group basis by the
2336 `gnus-group-charset-alist' variable and is only used on groups not
2337 covered by that variable."
2338   :type 'symbol
2339   :group 'gnus-charset)
2340
2341 ;; Fixme: Doc reference to agent.
2342 (defcustom gnus-agent t
2343   "Whether we want to use the Gnus agent or not.
2344
2345 You may customize gnus-agent to disable its use.  However, some
2346 back ends have started to use the agent as a client-side cache.
2347 Disabling the agent may result in noticeable loss of performance."
2348   :version "21.3"
2349   :group 'gnus-agent
2350   :type 'boolean)
2351
2352 (defcustom gnus-other-frame-function 'gnus
2353   "Function called by the command `gnus-other-frame'."
2354   :group 'gnus-start
2355   :type '(choice (function-item gnus)
2356                  (function-item gnus-no-server)
2357                  (function-item gnus-slave)
2358                  (function-item gnus-slave-no-server)))
2359
2360 (defcustom gnus-other-frame-parameters nil
2361   "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2362 This should be an alist for Emacs, or a plist for XEmacs."
2363   :group 'gnus-start
2364   :type (if (featurep 'xemacs)
2365             '(repeat (list :inline t :format "%v"
2366                            (symbol :tag "Property")
2367                            (sexp :tag "Value")))
2368           '(repeat (cons :format "%v"
2369                          (symbol :tag "Parameter")
2370                          (sexp :tag "Value")))))
2371
2372 (defcustom gnus-user-agent 'gnus-mime-edit
2373   "Which information should be exposed in the User-Agent header.
2374
2375 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2376 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2377 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2378 `emacs-gnus' plus system type\), `gnus-mime-edit' \(show Gnus version and
2379 MIME Edit User-Agent\) or a custom string.  If you set it to a string,
2380 be sure to use a valid format, see RFC 2616."
2381   :group 'gnus-message
2382   :type '(choice
2383           (item :tag "Show Gnus version and MIME Edit User-Agent"
2384                 gnus-mime-edit)
2385           (item :tag "Show Gnus and Emacs versions and system type"
2386                 emacs-gnus-type)
2387           (item :tag "Show Gnus and Emacs versions and system configuration"
2388                 emacs-gnus-config)
2389           (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2390           (item :tag "Show only Gnus version" gnus)
2391           (string :tag "Other")))
2392
2393 \f
2394 ;;; Internal variables
2395
2396 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2397 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2398 (defvar gnus-agent-method-p-cache nil
2399   ; Reset each time gnus-agent-covered-methods is changed else
2400   ; gnus-agent-method-p may mis-report a methods status.
2401   )
2402 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2403 (defvar gnus-draft-meta-information-header "X-Draft-From")
2404 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2405 (defvar gnus-original-article-buffer " *Original Article*")
2406 (defvar gnus-newsgroup-name nil)
2407 (defvar gnus-ephemeral-servers nil)
2408 (defvar gnus-server-method-cache nil)
2409
2410 (defvar gnus-agent-fetching nil
2411   "Whether Gnus agent is in fetching mode.")
2412
2413 (defvar gnus-agent-covered-methods nil
2414   "A list of servers, NOT methods, showing which servers are covered by the agent.")
2415
2416 (defvar gnus-command-method nil
2417   "Dynamically bound variable that says what the current back end is.")
2418
2419 (defvar gnus-current-select-method nil
2420   "The current method for selecting a newsgroup.")
2421
2422 (defvar gnus-tree-buffer "*Tree*"
2423   "Buffer where Gnus thread trees are displayed.")
2424
2425 ;; Dummy variable.
2426 (defvar gnus-use-generic-from nil)
2427
2428 ;; Variable holding the user answers to all method prompts.
2429 (defvar gnus-method-history nil)
2430
2431 ;; Variable holding the user answers to all mail method prompts.
2432 (defvar gnus-mail-method-history nil)
2433
2434 ;; Variable holding the user answers to all group prompts.
2435 (defvar gnus-group-history nil)
2436
2437 (defvar gnus-server-alist nil
2438   "List of available servers.")
2439
2440 (defcustom gnus-cache-directory
2441   (nnheader-concat gnus-directory "cache/")
2442   "*The directory where cached articles will be stored."
2443   :group 'gnus-cache
2444   :type 'directory)
2445
2446 (defvar gnus-predefined-server-alist
2447   `(("cache"
2448      nnspool "cache"
2449      (nnspool-spool-directory ,gnus-cache-directory)
2450      (nnspool-nov-directory ,gnus-cache-directory)
2451      (nnspool-active-file
2452       ,(nnheader-concat gnus-cache-directory "active"))))
2453   "List of predefined (convenience) servers.")
2454
2455 (defvar gnus-topic-indentation "");; Obsolete variable.
2456
2457 (defconst gnus-article-mark-lists
2458   '((marked . tick) (replied . reply)
2459     (expirable . expire) (killed . killed)
2460     (bookmarks . bookmark) (dormant . dormant)
2461     (scored . score) (saved . save)
2462     (cached . cache) (downloadable . download)
2463     (unsendable . unsend) (forwarded . forward)
2464     (recent . recent) (seen . seen)))
2465
2466 (defconst gnus-article-special-mark-lists
2467   '((seen range)
2468     (killed range)
2469     (bookmark tuple)
2470     (score tuple)))
2471
2472 ;; Propagate flags to server, with the following exceptions:
2473 ;; `seen' is private to each gnus installation
2474 ;; `cache' is a internal gnus flag for each gnus installation
2475 ;; `download' is a agent flag private to each gnus installation
2476 ;; `unsend' are for nndraft groups only
2477 ;; `score' is not a proper mark
2478 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2479 (defconst gnus-article-unpropagated-mark-lists
2480   '(seen cache download unsend score bookmark)
2481   "Marks that shouldn't be propagated to back ends.
2482 Typical marks are those that make no sense in a standalone back end,
2483 such as a mark that says whether an article is stored in the cache
2484 \(which doesn't make sense in a standalone back end).")
2485
2486 (defvar gnus-headers-retrieved-by nil)
2487 (defvar gnus-article-reply nil)
2488 (defvar gnus-override-method nil)
2489 (defvar gnus-article-check-size nil)
2490 (defvar gnus-opened-servers nil)
2491
2492 (defvar gnus-current-kill-article nil)
2493
2494 (defvar gnus-have-read-active-file nil)
2495
2496 (defconst gnus-maintainer
2497   "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
2498   "The mail address of the T-gnus maintainers.")
2499
2500 (defcustom gnus-info-filename nil
2501   "*Controls language of gnus Info.
2502 If nil and current-language-environment is Japanese, go to gnus-ja.
2503 Otherwise go to corresponding Info.
2504 This variable can be nil, gnus or gnus-ja."
2505   :group 'gnus-start
2506   :type '(choice (const nil)
2507                  (const :tag "English" gnus)
2508                  (const :tag "Japanese" gnus-ja)))
2509
2510 (defvar gnus-info-nodes
2511   '((gnus-group-mode "Group Buffer")
2512     (gnus-summary-mode "Summary Buffer")
2513     (gnus-article-mode "Article Buffer")
2514     (gnus-server-mode "Server Buffer")
2515     (gnus-browse-mode "Browse Foreign Server")
2516     (gnus-tree-mode "Tree Display"))
2517   "Alist of major modes and related Info nodes.")
2518
2519 (defvar gnus-group-buffer "*Group*")
2520 (defvar gnus-summary-buffer "*Summary*")
2521 (defvar gnus-article-buffer "*Article*")
2522 (defvar gnus-server-buffer "*Server*")
2523
2524 (defvar gnus-slave nil
2525   "Whether this Gnus is a slave or not.")
2526
2527 (defvar gnus-batch-mode nil
2528   "Whether this Gnus is running in batch mode or not.")
2529
2530 (defvar gnus-variable-list
2531   '(gnus-newsrc-options gnus-newsrc-options-n
2532                         gnus-newsrc-last-checked-date
2533                         gnus-newsrc-alist gnus-server-alist
2534                         gnus-killed-list gnus-zombie-list
2535                         gnus-topic-topology gnus-topic-alist)
2536   "Gnus variables saved in the quick startup file.")
2537
2538 (defvar gnus-product-variable-file-list
2539   (let ((version (product-version (product-find 'gnus-vers))))
2540     `(("strict-cache"
2541        ((product-version ,version)
2542         (emacs-version)
2543         (correct-string-widths))
2544        binary
2545        gnus-format-specs-compiled)
2546       ("cache"
2547        ((product-version ,version)
2548         (emacs-version)
2549         (correct-string-widths))
2550        ctext
2551        gnus-format-specs)))
2552   "Alist of the methods for checking whether the contents of the T-gnus
2553 quick startup files are valid.  One is for the byte-compiled format
2554 specifications, the other is for the source form.  Each element should
2555 be a list which looks like follows:
2556
2557 \(\"FILE_NAME\"
2558  ((VARIABLE EXPECTED_VALUE_or_NIL)
2559   (VARIABLE EXPECTED_VALUE_or_NIL)
2560   ...)
2561  CODING-SYSTEM_FOR_READING_FILE
2562  SYMBOL_OF_FORMAT_SPECS)")
2563
2564 (defcustom gnus-compile-user-specs t
2565   "If non-nil, the user-defined format specs will be byte-compiled
2566 automatically.
2567 It has an effect on the values of `gnus-*-line-format-spec'."
2568   :group 'gnus
2569   :type 'boolean)
2570
2571 (defvar gnus-newsrc-alist nil
2572   "Assoc list of read articles.
2573 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2574
2575 (defvar gnus-registry-alist nil
2576   "Assoc list of registry data.
2577 gnus-registry.el will populate this if it's loaded.")
2578
2579 (defvar gnus-newsrc-hashtb nil
2580   "Hashtable of `gnus-newsrc-alist'.")
2581
2582 (defvar gnus-killed-list nil
2583   "List of killed newsgroups.")
2584
2585 (defvar gnus-killed-hashtb nil
2586   "Hash table equivalent of `gnus-killed-list'.")
2587
2588 (defvar gnus-zombie-list nil
2589   "List of almost dead newsgroups.")
2590
2591 (defvar gnus-description-hashtb nil
2592   "Descriptions of newsgroups.")
2593
2594 (defvar gnus-list-of-killed-groups nil
2595   "List of newsgroups that have recently been killed by the user.")
2596
2597 (defvar gnus-active-hashtb nil
2598   "Hashtable of active articles.")
2599
2600 (defvar gnus-moderated-hashtb nil
2601   "Hashtable of moderated newsgroups.")
2602
2603 ;; Save window configuration.
2604 (defvar gnus-prev-winconf nil)
2605
2606 (defvar gnus-reffed-article-number nil)
2607
2608 ;;; Let the byte-compiler know that we know about this variable.
2609 (defvar rmail-default-rmail-file)
2610
2611 (defvar gnus-dead-summary nil)
2612
2613 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2614   "Regexp matching invalid groups.")
2615
2616 (defvar gnus-other-frame-object nil
2617   "A frame object which will be created by `gnus-other-frame'.")
2618
2619 ;;; End of variables.
2620
2621 ;; Define some autoload functions Gnus might use.
2622 (eval-and-compile
2623
2624   ;; This little mapcar goes through the list below and marks the
2625   ;; symbols in question as autoloaded functions.
2626   (mapcar
2627    (lambda (package)
2628      (let ((interactive (nth 1 (memq ':interactive package))))
2629        (mapcar
2630         (lambda (function)
2631           (let (keymap)
2632             (when (consp function)
2633               (setq keymap (car (memq 'keymap function)))
2634               (setq function (car function)))
2635             (unless (fboundp function)
2636               (autoload function (car package) nil interactive keymap))))
2637         (if (eq (nth 1 package) ':interactive)
2638             (nthcdr 3 package)
2639           (cdr package)))))
2640    '(("info" :interactive t Info-goto-node)
2641      ("pp" pp-to-string)
2642      ("ps-print" ps-print-preprint)
2643      ("message" :interactive t
2644       message-send-and-exit message-yank-original)
2645      ("babel" babel-as-string)
2646      ("nnmail" nnmail-split-fancy nnmail-article-group)
2647      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2648      ("rmailout" rmail-output rmail-output-to-rmail-file)
2649      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2650       rmail-show-message rmail-summary-exists
2651       rmail-select-summary rmail-update-summary)
2652      ("gnus-audio" :interactive t gnus-audio-play)
2653      ("gnus-xmas" gnus-xmas-splash)
2654      ("gnus-soup" :interactive t
2655       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2656       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2657      ("nnsoup" nnsoup-pack-replies)
2658      ("score-mode" :interactive t gnus-score-mode)
2659      ("gnus-mh" gnus-summary-save-article-folder
2660       gnus-Folder-save-name gnus-folder-save-name)
2661      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2662      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2663       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2664       gnus-demon-add-disconnection gnus-demon-add-handler
2665       gnus-demon-remove-handler)
2666      ("gnus-demon" :interactive t
2667       gnus-demon-init gnus-demon-cancel)
2668      ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2669       gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2670       gnus-face-from-file)
2671      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2672       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2673      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2674       gnus-nocem-unwanted-article-p)
2675      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2676       gnus-server-server-name)
2677      ("gnus-srvr" gnus-browse-foreign-server)
2678      ("gnus-cite" :interactive t
2679       gnus-article-highlight-citation gnus-article-hide-citation-maybe
2680       gnus-article-hide-citation gnus-article-fill-cited-article
2681       gnus-article-hide-citation-in-followups)
2682      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2683       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2684       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2685      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2686       gnus-cache-possibly-remove-articles gnus-cache-request-article
2687       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2688       gnus-cache-enter-remove-article gnus-cached-article-p
2689       gnus-cache-open gnus-cache-close gnus-cache-update-article
2690       gnus-cache-articles-in-group)
2691      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2692       gnus-cache-remove-article gnus-summary-insert-cached-articles)
2693      ("gnus-score" :interactive t
2694       gnus-summary-increase-score gnus-summary-set-score
2695       gnus-summary-raise-thread gnus-summary-raise-same-subject
2696       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2697       gnus-summary-lower-thread gnus-summary-lower-same-subject
2698       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2699       gnus-summary-current-score gnus-score-delta-default
2700       gnus-score-flush-cache gnus-score-close
2701       gnus-possibly-score-headers gnus-score-followup-article
2702       gnus-score-followup-thread)
2703      ("gnus-score"
2704       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2705       gnus-current-score-file-nondirectory gnus-score-adaptive
2706       gnus-score-find-trace gnus-score-file-name)
2707      ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2708       gnus-score-customize)
2709      ("gnus-topic" :interactive t gnus-topic-mode)
2710      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2711       gnus-subscribe-topics)
2712      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2713      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2714      ("gnus-uu" :interactive t
2715       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2716       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2717       gnus-uu-mark-by-regexp gnus-uu-mark-all
2718       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2719       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2720       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2721       gnus-uu-decode-binhex gnus-uu-decode-uu-view
2722       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2723       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2724       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2725       gnus-uu-mark-over gnus-uu-post-news)
2726      ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2727       gnus-uu-unmark-thread)
2728      ("gnus-msg" (gnus-summary-send-map keymap)
2729       gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2730      ("gnus-msg" :interactive t
2731       gnus-group-post-news gnus-group-mail gnus-group-news
2732       gnus-summary-post-news gnus-summary-news-other-window
2733       gnus-summary-followup gnus-summary-followup-with-original
2734       gnus-summary-cancel-article gnus-summary-supersede-article
2735       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2736       gnus-summary-mail-forward gnus-summary-mail-other-window
2737       gnus-summary-resend-message gnus-summary-resend-bounced-mail
2738       gnus-summary-wide-reply gnus-summary-followup-to-mail
2739       gnus-summary-followup-to-mail-with-original gnus-bug
2740       gnus-summary-wide-reply-with-original gnus-summary-post-forward
2741       gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2742      ("gnus-picon" :interactive t gnus-treat-from-picon)
2743      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2744       gnus-grouplens-mode)
2745      ("smiley" :interactive t smiley-region)
2746      ("gnus-win" gnus-configure-windows gnus-add-configuration)
2747      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2748       gnus-list-of-unread-articles gnus-list-of-read-articles
2749       gnus-offer-save-summaries gnus-make-thread-indent-array
2750       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2751       gnus-summary-skip-intangible gnus-summary-article-number
2752       gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2753      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2754       gnus-group-list-groups gnus-group-first-unread-group
2755       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2756       gnus-group-setup-buffer gnus-group-get-new-news
2757       gnus-group-make-help-group gnus-group-update-group
2758       gnus-group-iterate gnus-group-group-name)
2759      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2760       gnus-backlog-remove-article)
2761      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2762       gnus-article-prepare gnus-article-set-window-start
2763       gnus-article-next-page gnus-article-prev-page
2764       gnus-request-article-this-buffer gnus-article-mode
2765       gnus-article-setup-buffer gnus-narrow-to-page
2766       gnus-article-delete-invisible-text gnus-treat-article)
2767      ("gnus-art" :interactive t
2768       gnus-article-hide-headers gnus-article-hide-boring-headers
2769       gnus-article-treat-overstrike
2770       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2771       gnus-article-display-x-face
2772       gnus-article-decode-HZ
2773       gnus-article-wash-html
2774       gnus-article-unsplit-urls
2775       gnus-article-hide-pem gnus-article-hide-signature
2776       gnus-article-strip-leading-blank-lines gnus-article-date-local
2777       gnus-article-date-original gnus-article-date-lapsed
2778       gnus-article-show-all-headers
2779       ;; gnus-article-show-all
2780       gnus-article-edit-mode gnus-article-edit-article
2781       gnus-article-edit-done article-decode-encoded-words
2782       gnus-start-date-timer gnus-stop-date-timer)
2783      ("gnus-int" gnus-request-type)
2784      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2785       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2786      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2787       gnus-dup-enter-articles)
2788      ("gnus-range" gnus-copy-sequence)
2789      ("gnus-eform" gnus-edit-form)
2790      ("gnus-move" :interactive t
2791       gnus-group-move-group-to-server gnus-change-server)
2792      ("gnus-logic" gnus-score-advanced)
2793      ("gnus-undo" gnus-undo-mode gnus-undo-register)
2794      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2795       gnus-async-prefetch-article gnus-async-prefetch-remove-group
2796       gnus-async-halt-prefetch)
2797      ("gnus-offline"
2798       gnus-offline-setup)
2799      ("gnus-offline" :interactive t
2800       gnus-offline-toggle-plugged
2801       gnus-offline-set-unplugged-state
2802       gnus-offline-toggle-auto-hangup
2803       gnus-offline-toggle-on/off-send-mail
2804       gnus-offline-toggle-articles-to-fetch
2805       gnus-offline-set-interval-time
2806       gnus-offline-agent-expire)
2807      ("miee" :interactive t gnspool-get-news
2808       mail-spool-send news-spool-post)
2809      ("international/mw32misc" define-process-argument-editing
2810       general-process-argument-editing-function)
2811      ("gnus-agent" gnus-open-agent gnus-agent-get-function
2812       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2813       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2814       gnus-summary-set-agent-mark gnus-agent-save-group-info
2815       gnus-agent-request-article gnus-agent-retrieve-headers)
2816      ("gnus-agent" :interactive t
2817       gnus-unplugged gnus-agentize gnus-agent-batch)
2818      ("gnus-vm" :interactive t gnus-summary-save-in-vm
2819       gnus-summary-save-article-vm)
2820      ("compface" uncompface)
2821      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2822      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2823      ("gnus-mlspl" :interactive t gnus-group-split-setup
2824       gnus-group-split-update)
2825      ("gnus-delay" gnus-delay-initialize))))
2826
2827 (eval-and-compile
2828   (unless (featurep 'xemacs)
2829     (if (>= emacs-major-version 21)
2830         (autoload 'x-face-decode-message-header "x-face-e21")
2831       (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule"))))
2832
2833 (unless (and (fboundp 'base64-encode-string)
2834              (subrp (symbol-function 'base64-encode-string)))
2835   (require 'base64))
2836
2837 ;; To search articles with Namazu.
2838 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
2839 (autoload 'gnus-namazu-create-index "gnus-namazu" nil t)
2840 (autoload 'gnus-namazu-update-index "gnus-namazu" nil t)
2841 (autoload 'gnus-namazu-update-all-indices "gnus-namazu" nil t)
2842
2843 ;; To make nnir groups.
2844 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
2845
2846 ;; To make shimbun groups.
2847 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
2848
2849 ;; A tool for the developers.
2850 (autoload 'find-cl-run-time-functions "gnus-clfns" nil t)
2851
2852 ;;; gnus-sum.el thingies
2853
2854
2855 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2856   "*The format specification of the lines in the summary buffer.
2857
2858 It works along the same lines as a normal formatting string,
2859 with some simple extensions.
2860
2861 %N   Article number, left padded with spaces (string)
2862 %S   Subject (string)
2863 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
2864 %n   Name of the poster (string)
2865 %a   Extracted name of the poster (string)
2866 %A   Extracted address of the poster (string)
2867 %F   Contents of the From: header (string)
2868 %f   Contents of the From: or To: headers (string)
2869 %x   Contents of the Xref: header (string)
2870 %D   Date of the article (string)
2871 %d   Date of the article (string) in DD-MMM format
2872 %o   Date of the article (string) in YYYYMMDD`T'HHMMSS format
2873 %M   Message-id of the article (string)
2874 %r   References of the article (string)
2875 %c   Number of characters in the article (integer)
2876 %k   Pretty-printed version of the above (string)
2877      For example, \"1.2k\" or \"0.4M\".
2878 %L   Number of lines in the article (integer)
2879 %I   Indentation based on thread level (a string of spaces)
2880 %B   A complex trn-style thread tree (string)
2881      The variables `gnus-sum-thread-*' can be used for customization.
2882 %T   A string with two possible values: 80 spaces if the article
2883      is on thread level two or larger and 0 spaces on level one
2884 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
2885 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2886 %[   Opening bracket (character, \"[\" or \"<\")
2887 %]   Closing bracket (character, \"]\" or \">\")
2888 %>   Spaces of length thread-level (string)
2889 %<   Spaces of length (- 20 thread-level) (string)
2890 %i   Article score (number)
2891 %z   Article zcore (character)
2892 %t   Number of articles under the current thread (number).
2893 %e   Whether the thread is empty or not (character).
2894 %l   GroupLens score (string).
2895 %V   Total thread score (number).
2896 %P   The line number (number).
2897 %O   Download mark (character).
2898 %*   If present, indicates desired cursor position
2899      (instead of after first colon).
2900 %u   User defined specifier.  The next character in the format string should
2901      be a letter.  Gnus will call the function gnus-user-format-function-X,
2902      where X is the letter following %u.  The function will be passed the
2903      current header as argument.  The function should return a string, which
2904      will be inserted into the summary just like information from any other
2905      summary specifier.
2906
2907 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2908 with care.  For reasons of efficiency, Gnus will compute what column
2909 these characters will end up in, and \"hard-code\" that.  This means that
2910 it is invalid to have these specs after a variable-length spec.  Well,
2911 you might not be arrested, but your summary buffer will look strange,
2912 which is bad enough.
2913
2914 The smart choice is to have these specs as far to the left as
2915 possible.
2916
2917 This restriction may disappear in later versions of Gnus.
2918
2919 General format specifiers can also be used.
2920 See Info node `(gnus)Formatting Variables'."
2921   :link '(custom-manual "(gnus)Formatting Variables")
2922   :type 'string
2923   :group 'gnus-summary-format)
2924
2925 ;;;
2926 ;;; Skeleton keymaps
2927 ;;;
2928
2929 (defun gnus-suppress-keymap (keymap)
2930   (suppress-keymap keymap)
2931   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2932     (while keys
2933       (define-key keymap (pop keys) 'undefined))))
2934
2935 (defvar gnus-article-mode-map
2936   (let ((keymap (make-sparse-keymap)))
2937     (gnus-suppress-keymap keymap)
2938     keymap))
2939 (defvar gnus-summary-mode-map
2940   (let ((keymap (make-keymap)))
2941     (gnus-suppress-keymap keymap)
2942     keymap))
2943 (defvar gnus-group-mode-map
2944   (let ((keymap (make-keymap)))
2945     (gnus-suppress-keymap keymap)
2946     keymap))
2947
2948 \f
2949
2950 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2951 ;; If you want the cursor to go somewhere else, set these two
2952 ;; functions in some startup hook to whatever you want.
2953 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2954 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2955
2956 ;;; Various macros and substs.
2957
2958 (defun gnus-header-from (header)
2959   (mail-header-from header))
2960
2961 (defmacro gnus-gethash (string hashtable)
2962   "Get hash value of STRING in HASHTABLE."
2963   `(symbol-value (intern-soft ,string ,hashtable)))
2964
2965 (defmacro gnus-gethash-safe (string hashtable)
2966   "Get hash value of STRING in HASHTABLE.
2967 Return nil if not defined."
2968   `(let ((sym (intern-soft ,string ,hashtable)))
2969      (and (boundp sym) (symbol-value sym))))
2970
2971 (defmacro gnus-sethash (string value hashtable)
2972   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
2973   `(set (intern ,string ,hashtable) ,value))
2974 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2975
2976 (defmacro gnus-group-unread (group)
2977   "Get the currently computed number of unread articles in GROUP."
2978   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2979
2980 (defmacro gnus-group-entry (group)
2981   "Get the newsrc entry for GROUP."
2982   `(gnus-gethash ,group gnus-newsrc-hashtb))
2983
2984 (defmacro gnus-active (group)
2985   "Get active info on GROUP."
2986   `(gnus-gethash ,group gnus-active-hashtb))
2987
2988 (defmacro gnus-set-active (group active)
2989   "Set GROUP's active info."
2990   `(gnus-sethash ,group ,active gnus-active-hashtb))
2991
2992 ;; Info access macros.
2993
2994 (defmacro gnus-info-group (info)
2995   `(nth 0 ,info))
2996 (defmacro gnus-info-rank (info)
2997   `(nth 1 ,info))
2998 (defmacro gnus-info-read (info)
2999   `(nth 2 ,info))
3000 (defmacro gnus-info-marks (info)
3001   `(nth 3 ,info))
3002 (defmacro gnus-info-method (info)
3003   `(nth 4 ,info))
3004 (defmacro gnus-info-params (info)
3005   `(nth 5 ,info))
3006
3007 (defmacro gnus-info-level (info)
3008   `(let ((rank (gnus-info-rank ,info)))
3009      (if (consp rank)
3010          (car rank)
3011        rank)))
3012 (defmacro gnus-info-score (info)
3013   `(let ((rank (gnus-info-rank ,info)))
3014      (or (and (consp rank) (cdr rank)) 0)))
3015
3016 (defmacro gnus-info-set-group (info group)
3017   `(setcar ,info ,group))
3018 (defmacro gnus-info-set-rank (info rank)
3019   `(setcar (nthcdr 1 ,info) ,rank))
3020 (defmacro gnus-info-set-read (info read)
3021   `(setcar (nthcdr 2 ,info) ,read))
3022 (defmacro gnus-info-set-marks (info marks &optional extend)
3023   (if extend
3024       `(gnus-info-set-entry ,info ,marks 3)
3025     `(setcar (nthcdr 3 ,info) ,marks)))
3026 (defmacro gnus-info-set-method (info method &optional extend)
3027   (if extend
3028       `(gnus-info-set-entry ,info ,method 4)
3029     `(setcar (nthcdr 4 ,info) ,method)))
3030 (defmacro gnus-info-set-params (info params &optional extend)
3031   (if extend
3032       `(gnus-info-set-entry ,info ,params 5)
3033     `(setcar (nthcdr 5 ,info) ,params)))
3034
3035 (defun gnus-info-set-entry (info entry number)
3036   ;; Extend the info until we have enough elements.
3037   (while (<= (length info) number)
3038     (nconc info (list nil)))
3039   ;; Set the entry.
3040   (setcar (nthcdr number info) entry))
3041
3042 (defmacro gnus-info-set-level (info level)
3043   `(let ((rank (cdr ,info)))
3044      (if (consp (car rank))
3045          (setcar (car rank) ,level)
3046        (setcar rank ,level))))
3047 (defmacro gnus-info-set-score (info score)
3048   `(let ((rank (cdr ,info)))
3049      (if (consp (car rank))
3050          (setcdr (car rank) ,score)
3051        (setcar rank (cons (car rank) ,score)))))
3052
3053 (defmacro gnus-get-info (group)
3054   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3055
3056 ;;; Load the compatibility functions.
3057
3058 (require 'gnus-ems)
3059
3060 \f
3061 ;;;
3062 ;;; Shutdown
3063 ;;;
3064
3065 (defvar gnus-shutdown-alist nil)
3066
3067 (defun gnus-add-shutdown (function &rest symbols)
3068   "Run FUNCTION whenever one of SYMBOLS is shut down."
3069   (push (cons function symbols) gnus-shutdown-alist))
3070
3071 (defun gnus-shutdown (symbol)
3072   "Shut down everything that waits for SYMBOL."
3073   (let ((alist gnus-shutdown-alist)
3074         entry)
3075     (while (setq entry (pop alist))
3076       (when (memq symbol (cdr entry))
3077         (funcall (car entry))))))
3078
3079 \f
3080 ;;;
3081 ;;; Gnus Utility Functions
3082 ;;;
3083
3084 (defun gnus-find-subscribed-addresses ()
3085   "Return a regexp matching the addresses of all subscribed mail groups.
3086 It consists of the `to-address' or `to-list' parameter of all groups
3087 with a `subscribed' parameter."
3088   (let (group address addresses)
3089     (dolist (entry (cdr gnus-newsrc-alist))
3090       (setq group (car entry))
3091       (when (gnus-parameter-subscribed group)
3092         (setq address (mail-strip-quoted-names
3093                        (or (gnus-group-fast-parameter group 'to-address)
3094                            (gnus-group-fast-parameter group 'to-list))))
3095         (when address
3096           (add-to-list 'addresses address))))
3097     (when addresses
3098       (list (mapconcat 'regexp-quote addresses "\\|")))))
3099
3100 (defmacro gnus-string-or (&rest strings)
3101   "Return the first element of STRINGS that is a non-blank string.
3102 STRINGS will be evaluated in normal `or' order."
3103   `(gnus-string-or-1 ',strings))
3104
3105 (defun gnus-string-or-1 (strings)
3106   (let (string)
3107     (while strings
3108       (setq string (eval (pop strings)))
3109       (if (string-match "^[ \t]*$" string)
3110           (setq string nil)
3111         (setq strings nil)))
3112     string))
3113
3114 (defun gnus-info-find-node (&optional nodename)
3115   "Find Info documentation of Gnus."
3116   (interactive)
3117   ;; Enlarge info window if needed.
3118   (let (gnus-info-buffer)
3119     (Info-goto-node
3120      (format "(%s)%s"
3121              (or gnus-info-filename
3122                  (get-language-info current-language-environment 'gnus-info)
3123                  "gnus")
3124              (or nodename
3125                  (cadr (assq major-mode gnus-info-nodes))
3126                  (and (eq (current-buffer) (get-buffer gnus-article-buffer))
3127                       (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
3128     (setq gnus-info-buffer (current-buffer))
3129     (gnus-configure-windows 'info)))
3130
3131 ;;;
3132 ;;; gnus-interactive
3133 ;;;
3134
3135 (defvar gnus-current-prefix-symbol nil
3136   "Current prefix symbol.")
3137
3138 (defvar gnus-current-prefix-symbols nil
3139   "List of current prefix symbols.")
3140
3141 (defun gnus-interactive (string &optional params)
3142   "Return a list that can be fed to `interactive'.
3143 See `interactive' for full documentation.
3144
3145 Adds the following specs:
3146
3147 y -- The current symbolic prefix.
3148 Y -- A list of the current symbolic prefix(es).
3149 A -- Article number.
3150 H -- Article header.
3151 g -- Group name."
3152   (let ((i 0)
3153         out c prompt)
3154     (while (< i (length string))
3155       (string-match ".\\([^\n]*\\)\n?" string i)
3156       (setq c (aref string i))
3157       (when (match-end 1)
3158         (setq prompt (match-string 1 string)))
3159       (setq i (match-end 0))
3160       ;; We basically emulate just about everything that
3161       ;; `interactive' does, but add the specs listed above.
3162       (push
3163        (cond
3164         ((= c ?a)
3165          (completing-read prompt obarray 'fboundp t))
3166         ((= c ?b)
3167          (read-buffer prompt (current-buffer) t))
3168         ((= c ?B)
3169          (read-buffer prompt (other-buffer (current-buffer))))
3170         ((= c ?c)
3171          (read-char))
3172         ((= c ?C)
3173          (completing-read prompt obarray 'commandp t))
3174         ((= c ?d)
3175          (point))
3176         ((= c ?D)
3177          (read-file-name prompt nil default-directory 'lambda))
3178         ((= c ?f)
3179          (read-file-name prompt nil nil 'lambda))
3180         ((= c ?F)
3181          (read-file-name prompt))
3182         ((= c ?k)
3183          (read-key-sequence prompt))
3184         ((= c ?K)
3185          (error "Not implemented spec"))
3186         ((= c ?e)
3187          (error "Not implemented spec"))
3188         ((= c ?m)
3189          (mark))
3190         ((= c ?N)
3191          (error "Not implemented spec"))
3192         ((= c ?n)
3193          (string-to-number (read-from-minibuffer prompt)))
3194         ((= c ?p)
3195          (prefix-numeric-value current-prefix-arg))
3196         ((= c ?P)
3197          current-prefix-arg)
3198         ((= c ?r)
3199          'gnus-prefix-nil)
3200         ((= c ?s)
3201          (read-string prompt))
3202         ((= c ?S)
3203          (intern (read-string prompt)))
3204         ((= c ?v)
3205          (read-variable prompt))
3206         ((= c ?x)
3207          (read-minibuffer prompt))
3208         ((= c ?x)
3209          (eval-minibuffer prompt))
3210         ;; And here the new specs come.
3211         ((= c ?y)
3212          gnus-current-prefix-symbol)
3213         ((= c ?Y)
3214          gnus-current-prefix-symbols)
3215         ((= c ?g)
3216          (gnus-group-group-name))
3217         ((= c ?A)
3218          (gnus-summary-skip-intangible)
3219          (or (get-text-property (point) 'gnus-number)
3220              (gnus-summary-last-subject)))
3221         ((= c ?H)
3222          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3223         (t
3224          (error "Non-implemented spec")))
3225        out)
3226       (cond
3227        ((= c ?r)
3228         (push (if (< (point) (mark)) (point) (mark)) out)
3229         (push (if (> (point) (mark)) (point) (mark)) out))))
3230     (setq out (delq 'gnus-prefix-nil out))
3231     (nreverse out)))
3232
3233 (defun gnus-symbolic-argument (&optional arg)
3234   "Read a symbolic argument and a command, and then execute command."
3235   (interactive "P")
3236   (let* ((in-command (this-command-keys))
3237          (command in-command)
3238          gnus-current-prefix-symbols
3239          gnus-current-prefix-symbol
3240          syms)
3241     (while (equal in-command command)
3242       (message "%s-" (key-description (this-command-keys)))
3243       (push (intern (char-to-string (read-char))) syms)
3244       (setq command (read-key-sequence nil t)))
3245     (setq gnus-current-prefix-symbols (nreverse syms)
3246           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3247     (call-interactively (key-binding command t))))
3248
3249 ;;; More various functions.
3250
3251 (defsubst gnus-check-backend-function (func group)
3252   "Check whether GROUP supports function FUNC.
3253 GROUP can either be a string (a group name) or a select method."
3254   (ignore-errors
3255     (let ((method (if (stringp group)
3256                       (car (gnus-find-method-for-group group))
3257                     group)))
3258       (unless (featurep method)
3259         (require method))
3260       (fboundp (intern (format "%s-%s" method func))))))
3261
3262 (defun gnus-group-read-only-p (&optional group)
3263   "Check whether GROUP supports editing or not.
3264 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
3265 that that variable is buffer-local to the summary buffers."
3266   (let ((group (or group gnus-newsgroup-name)))
3267     (not (gnus-check-backend-function 'request-replace-article group))))
3268
3269 (defun gnus-virtual-group-p (group)
3270   "Say whether GROUP is virtual or not."
3271   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3272                         gnus-valid-select-methods)))
3273
3274 (defun gnus-news-group-p (group &optional article)
3275   "Return non-nil if GROUP (and ARTICLE) come from a news server."
3276   (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3277          t)                             ;is news of course.
3278         ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3279          nil)                           ;must be mail then.
3280         ((vectorp article)              ;Has header info.
3281          (eq (gnus-request-type group (mail-header-id article)) 'news))
3282         ((null article)                 ;Hasn't header info
3283          (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3284         ((< article 0)                  ;Virtual message
3285          nil)                           ;we don't know, guess mail.
3286         (t                              ;Has positive number
3287          (eq (gnus-request-type group article) 'news)))) ;use it.
3288
3289 ;; Returns a list of writable groups.
3290 (defun gnus-writable-groups ()
3291   (let ((alist gnus-newsrc-alist)
3292         groups group)
3293     (while (setq group (car (pop alist)))
3294       (unless (gnus-group-read-only-p group)
3295         (push group groups)))
3296     (nreverse groups)))
3297
3298 ;; Check whether to use long file names.
3299 (defun gnus-use-long-file-name (symbol)
3300   ;; The variable has to be set...
3301   (and gnus-use-long-file-name
3302        ;; If it isn't a list, then we return t.
3303        (or (not (listp gnus-use-long-file-name))
3304            ;; If it is a list, and the list contains `symbol', we
3305            ;; return nil.
3306            (not (memq symbol gnus-use-long-file-name)))))
3307
3308 ;; Generate a unique new group name.
3309 (defun gnus-generate-new-group-name (leaf)
3310   (let ((name leaf)
3311         (num 0))
3312     (while (gnus-gethash name gnus-newsrc-hashtb)
3313       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3314     name))
3315
3316 (defun gnus-ephemeral-group-p (group)
3317   "Say whether GROUP is ephemeral or not."
3318   (gnus-group-get-parameter group 'quit-config t))
3319
3320 (defun gnus-group-quit-config (group)
3321   "Return the quit-config of GROUP."
3322   (gnus-group-get-parameter group 'quit-config t))
3323
3324 (defun gnus-kill-ephemeral-group (group)
3325   "Remove ephemeral GROUP from relevant structures."
3326   (gnus-sethash group nil gnus-newsrc-hashtb))
3327
3328 (defun gnus-simplify-mode-line ()
3329   "Make mode lines a bit simpler."
3330   (setq mode-line-modified (cdr gnus-mode-line-modified))
3331   (when (listp mode-line-format)
3332     (make-local-variable 'mode-line-format)
3333     (setq mode-line-format (copy-sequence mode-line-format))
3334     (when (equal (nth 3 mode-line-format) "   ")
3335       (setcar (nthcdr 3 mode-line-format) " "))))
3336
3337 ;;; Servers and groups.
3338
3339 (defsubst gnus-server-add-address (method)
3340   (let ((method-name (symbol-name (car method))))
3341     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3342              (not (assq (intern (concat method-name "-address")) method))
3343              (memq 'physical-address (assq (car method)
3344                                            gnus-valid-select-methods)))
3345         (append method (list (list (intern (concat method-name "-address"))
3346                                    (nth 1 method))))
3347       method)))
3348
3349 (defsubst gnus-server-to-method (server)
3350   "Map virtual server names to select methods."
3351   (or (and server (listp server) server)
3352       (cdr (assoc server gnus-server-method-cache))
3353       (let ((result
3354              (or
3355               ;; Perhaps this is the native server?
3356               (and (equal server "native") gnus-select-method)
3357               ;; It should be in the server alist.
3358               (cdr (assoc server gnus-server-alist))
3359               ;; It could be in the predefined server alist.
3360               (cdr (assoc server gnus-predefined-server-alist))
3361               ;; If not, we look through all the opened server
3362               ;; to see whether we can find it there.
3363               (let ((opened gnus-opened-servers))
3364                 (while (and opened
3365                             (not (equal server (format "%s:%s" (caaar opened)
3366                                                        (cadaar opened)))))
3367                   (pop opened))
3368                 (caar opened))
3369               ;; It could be a named method, search all servers
3370               (let ((servers gnus-secondary-select-methods))
3371                 (while (and servers
3372                             (not (equal server (format "%s:%s" (caar servers)
3373                                                        (cadar servers)))))
3374                   (pop servers))
3375                 (car servers))
3376               ;; This could be some sort of foreign server that I
3377               ;; simply haven't opened (yet).  Do a brute-force scan
3378               ;; of the entire gnus-newsrc-alist for the server name
3379               ;; of every method.  As a side-effect, loads the
3380               ;; gnus-server-method-cache so this only happens once,
3381               ;; if at all.
3382               (let (match)
3383                 (mapcar
3384                  (lambda (info)
3385                    (let ((info-method (gnus-info-method info)))
3386                      (unless (stringp info-method)
3387                        (let ((info-server (gnus-method-to-server info-method)))
3388                          (when (equal server info-server)
3389                            (setq match info-method))))))
3390                  (cdr gnus-newsrc-alist))
3391                 match))))
3392         (when result
3393           (push (cons server result) gnus-server-method-cache))
3394         result)))
3395
3396 (defsubst gnus-method-to-server (method)
3397   (catch 'server-name
3398     (setq method (or method gnus-select-method))
3399
3400     ;; Perhaps it is already in the cache.
3401     (mapc (lambda (name-method)
3402             (if (equal (cdr name-method) method)
3403                 (throw 'server-name (car name-method))))
3404           gnus-server-method-cache)
3405
3406     (mapc
3407      (lambda (server-alist)
3408        (mapc (lambda (name-method)
3409                (when (gnus-methods-equal-p (cdr name-method) method)
3410                  (unless (member name-method gnus-server-method-cache)
3411                    (push name-method gnus-server-method-cache))
3412                  (throw 'server-name (car name-method))))
3413              server-alist))
3414      (let ((alists (list gnus-server-alist
3415                          gnus-predefined-server-alist)))
3416        (if gnus-select-method
3417            (push (list (cons "native" gnus-select-method)) alists))
3418        alists))
3419
3420     (let* ((name (if (member (cadr method) '(nil ""))
3421                      (format "%s" (car method))
3422                    (format "%s:%s" (car method) (cadr method))))
3423            (name-method (cons name method)))
3424       (unless (member name-method gnus-server-method-cache)
3425         (push name-method gnus-server-method-cache))
3426       name)))
3427
3428 (defsubst gnus-server-get-method (group method)
3429   ;; Input either a server name, and extended server name, or a
3430   ;; select method, and return a select method.
3431   (cond ((stringp method)
3432          (gnus-server-to-method method))
3433         ((equal method gnus-select-method)
3434          gnus-select-method)
3435         ((and (stringp (car method))
3436               group)
3437          (gnus-server-extend-method group method))
3438         ((and method
3439               (not group)
3440               (equal (cadr method) ""))
3441          method)
3442         (t
3443          (gnus-server-add-address method))))
3444
3445 (defmacro gnus-method-equal (ss1 ss2)
3446   "Say whether two servers are equal."
3447   `(let ((s1 ,ss1)
3448          (s2 ,ss2))
3449      (or (equal s1 s2)
3450          (and (= (length s1) (length s2))
3451               (progn
3452                 (while (and s1 (member (car s1) s2))
3453                   (setq s1 (cdr s1)))
3454                 (null s1))))))
3455
3456 (defun gnus-methods-equal-p (m1 m2)
3457   (let ((m1 (or m1 gnus-select-method))
3458         (m2 (or m2 gnus-select-method)))
3459     (or (equal m1 m2)
3460         (and (eq (car m1) (car m2))
3461              (or (not (memq 'address (assoc (symbol-name (car m1))
3462                                             gnus-valid-select-methods)))
3463                  (equal (nth 1 m1) (nth 1 m2)))))))
3464
3465 (defun gnus-server-equal (m1 m2)
3466   "Say whether two methods are equal."
3467   (let ((m1 (cond ((null m1) gnus-select-method)
3468                   ((stringp m1) (gnus-server-to-method m1))
3469                   (t m1)))
3470         (m2 (cond ((null m2) gnus-select-method)
3471                   ((stringp m2) (gnus-server-to-method m2))
3472                   (t m2))))
3473     (gnus-method-equal m1 m2)))
3474
3475 (defun gnus-servers-using-backend (backend)
3476   "Return a list of known servers using BACKEND."
3477   (let ((opened gnus-opened-servers)
3478         out)
3479     (while opened
3480       (when (eq backend (caaar opened))
3481         (push (caar opened) out))
3482       (pop opened))
3483     out))
3484
3485 (defun gnus-archive-server-wanted-p ()
3486   "Say whether the user wants to use the archive server."
3487   (cond
3488    ((or (not gnus-message-archive-method)
3489         (not gnus-message-archive-group))
3490     nil)
3491    ((and gnus-message-archive-method gnus-message-archive-group)
3492     t)
3493    (t
3494     (let ((active (cadr (assq 'nnfolder-active-file
3495                               gnus-message-archive-method))))
3496       (and active
3497            (file-exists-p active))))))
3498
3499 (defsubst gnus-method-to-server-name (method)
3500   (concat
3501    (format "%s" (car method))
3502    (when (and
3503           (or (assoc (format "%s" (car method))
3504                      (gnus-methods-using 'address))
3505               (gnus-server-equal method gnus-message-archive-method))
3506           (nth 1 method)
3507           (not (string= (nth 1 method) "")))
3508      (concat "+" (nth 1 method)))))
3509
3510 (defsubst gnus-method-to-full-server-name (method)
3511   (format "%s+%s" (car method) (nth 1 method)))
3512
3513 (defun gnus-group-prefixed-name (group method &optional full)
3514   "Return the whole name from GROUP and METHOD.
3515 Call with full set to get the fully qualified group name (even if the
3516 server is native)."
3517   (when (stringp method)
3518     (setq method (gnus-server-to-method method)))
3519   (if (or (not method)
3520           (and (not full) (gnus-server-equal method "native"))
3521           ;;;!!! This might not be right.  We'll see...
3522           ;(string-match ":" group)
3523           )
3524       group
3525     (concat (gnus-method-to-server-name method) ":" group)))
3526
3527 (defun gnus-group-guess-prefixed-name (group)
3528   "Guess the whole name from GROUP and METHOD."
3529   (gnus-group-prefixed-name group (gnus-find-method-for-group
3530                                group)))
3531
3532 (defun gnus-group-full-name (group method)
3533   "Return the full name from GROUP and METHOD, even if the method is native."
3534   (gnus-group-prefixed-name group method t))
3535
3536 (defun gnus-group-guess-full-name (group)
3537   "Guess the full name from GROUP, even if the method is native."
3538   (if (gnus-group-prefixed-p group)
3539       group
3540     (gnus-group-full-name group (gnus-find-method-for-group group))))
3541
3542 (defun gnus-group-guess-full-name-from-command-method (group)
3543   "Guess the full name from GROUP, even if the method is native."
3544   (if (gnus-group-prefixed-p group)
3545       group
3546     (gnus-group-full-name group gnus-command-method)))
3547
3548 (defun gnus-group-real-prefix (group)
3549   "Return the prefix of the current group name."
3550   (if (stringp group)
3551       (if (string-match "^[^:]+:" group)
3552           (substring group 0 (match-end 0))
3553         "")
3554     nil))
3555
3556 (defun gnus-group-short-name (group)
3557   "Return the short group name."
3558   (let ((prefix (gnus-group-real-prefix group)))
3559     (if (< 0 (length prefix))
3560         (substring group (length prefix) nil)
3561       group)))
3562
3563 (defun gnus-group-prefixed-p (group)
3564   "Return the prefix of the current group name."
3565   (< 0 (length (gnus-group-real-prefix group))))
3566
3567 (defun gnus-summary-buffer-name (group)
3568   "Return the summary buffer name of GROUP."
3569   (concat "*Summary " (gnus-group-decoded-name group) "*"))
3570
3571 (defun gnus-group-method (group)
3572   "Return the server or method used for selecting GROUP.
3573 You should probably use `gnus-find-method-for-group' instead."
3574   (let ((prefix (gnus-group-real-prefix group)))
3575     (if (equal prefix "")
3576         gnus-select-method
3577       (let ((servers gnus-opened-servers)
3578             (server "")
3579             backend possible found)
3580         (if (string-match "^[^\\+]+\\+" prefix)
3581             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3582                   server (substring prefix (match-end 0) (1- (length prefix))))
3583           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3584         (while servers
3585           (when (eq (caaar servers) backend)
3586             (setq possible (caar servers))
3587             (when (equal (cadaar servers) server)
3588               (setq found (caar servers))))
3589           (pop servers))
3590         (or (car (rassoc found gnus-server-alist))
3591             found
3592             (car (rassoc possible gnus-server-alist))
3593             possible
3594             (list backend server))))))
3595
3596 (defsubst gnus-native-method-p (method)
3597   "Return whether METHOD is the native select method."
3598   (gnus-method-equal method gnus-select-method))
3599
3600 (defsubst gnus-secondary-method-p (method)
3601   "Return whether METHOD is a secondary select method."
3602   (let ((methods gnus-secondary-select-methods)
3603         (gmethod (inline (gnus-server-get-method nil method))))
3604     (while (and methods
3605                 (not (gnus-method-equal
3606                       (inline (gnus-server-get-method nil (car methods)))
3607                       gmethod)))
3608       (setq methods (cdr methods)))
3609     methods))
3610
3611 (defun gnus-method-simplify (method)
3612   "Return the shortest uniquely identifying string or method for METHOD."
3613   (cond ((stringp method)
3614          method)
3615         ((gnus-native-method-p method)
3616          nil)
3617         ((gnus-secondary-method-p method)
3618          (format "%s:%s" (nth 0 method) (nth 1 method)))
3619         (t
3620          method)))
3621
3622 (defun gnus-groups-from-server (server)
3623   "Return a list of all groups that are fetched from SERVER."
3624   (let ((alist (cdr gnus-newsrc-alist))
3625         info groups)
3626     (while (setq info (pop alist))
3627       (when (gnus-server-equal (gnus-info-method info) server)
3628         (push (gnus-info-group info) groups)))
3629     (sort groups 'string<)))
3630
3631 (defun gnus-group-foreign-p (group)
3632   "Say whether a group is foreign or not."
3633   (and (not (gnus-group-native-p group))
3634        (not (gnus-group-secondary-p group))))
3635
3636 (defun gnus-group-native-p (group)
3637   "Say whether the group is native or not."
3638   (not (string-match ":" group)))
3639
3640 (defun gnus-group-secondary-p (group)
3641   "Say whether the group is secondary or not."
3642   (gnus-secondary-method-p (gnus-find-method-for-group group)))
3643
3644 (defun gnus-parameters-get-parameter (group)
3645   "Return the group parameters for GROUP from `gnus-parameters'."
3646   (let (params-list)
3647     (dolist (elem gnus-parameters)
3648       (when (string-match (car elem) group)
3649         (setq params-list
3650               (nconc (gnus-expand-group-parameters
3651                       (car elem) (cdr elem) group)
3652                      params-list))))
3653     params-list))
3654
3655 (defun gnus-expand-group-parameter (match value group)
3656   "Use MATCH to expand VALUE in GROUP."
3657   (with-temp-buffer
3658     (insert group)
3659     (goto-char (point-min))
3660     (while (re-search-forward match nil t)
3661       (replace-match value))
3662     (buffer-string)))
3663
3664 (defun gnus-expand-group-parameters (match parameters group)
3665   "Go through PARAMETERS and expand them according to the match data."
3666   (let (new)
3667     (dolist (elem parameters)
3668       (if (and (stringp (cdr elem))
3669                (string-match "\\\\[0-9&]" (cdr elem)))
3670           (push (cons (car elem)
3671                       (gnus-expand-group-parameter match (cdr elem) group))
3672                 new)
3673         (push elem new)))
3674     new))
3675
3676 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3677   "For GROUP, return the value of SYMBOL.
3678
3679 You should call this in the `gnus-group-buffer' buffer.
3680 The function `gnus-group-find-parameter' will do that for you."
3681   ;; The speed trick:  No cons'ing and quit early.
3682   (let* ((params (funcall gnus-group-get-parameter-function group))
3683          ;; Start easy, check the "real" group parameters.
3684          (simple-results
3685           (gnus-group-parameter-value params symbol allow-list t)))
3686     (if simple-results
3687         ;; Found results; return them.
3688         (car simple-results)
3689       ;; We didn't found it there, try `gnus-parameters'.
3690       (let ((result nil)
3691             (head nil)
3692             (tail gnus-parameters))
3693         ;; A good old-fashioned non-cl loop.
3694         (while tail
3695           (setq head (car tail)
3696                 tail (cdr tail))
3697           ;; The car is regexp matching for matching the group name.
3698           (when (string-match (car head) group)
3699             ;; The cdr is the parameters.
3700             (setq result (gnus-group-parameter-value (cdr head)
3701                                                      symbol allow-list))
3702             (when result
3703               ;; Expand if necessary.
3704               (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3705                   (setq result (gnus-expand-group-parameter (car head)
3706                                                             result group)))
3707               ;; Exit the loop early.
3708               (setq tail nil))))
3709         ;; Done.
3710         result))))
3711
3712 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3713   "Return the group parameters for GROUP.
3714 If SYMBOL, return the value of that symbol in the group parameters.
3715
3716 If you call this function inside a loop, consider using the faster
3717 `gnus-group-fast-parameter' instead."
3718   (save-excursion
3719     (set-buffer gnus-group-buffer)
3720     (if symbol
3721         (gnus-group-fast-parameter group symbol allow-list)
3722       (nconc
3723        (copy-sequence
3724         (funcall gnus-group-get-parameter-function group))
3725        (gnus-parameters-get-parameter group)))))
3726
3727 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3728   "Return the group parameters for GROUP.
3729 If SYMBOL, return the value of that symbol in the group parameters.
3730 Most functions should use `gnus-group-find-parameter', which
3731 also examines the topic parameters."
3732   (let ((params (gnus-info-params (gnus-get-info group))))
3733     (if symbol
3734         (gnus-group-parameter-value params symbol allow-list)
3735       params)))
3736
3737 (defun gnus-group-parameter-value (params symbol &optional
3738                                           allow-list present-p)
3739   "Return the value of SYMBOL in group PARAMS."
3740   ;; We only wish to return group parameters (dotted lists) and
3741   ;; not local variables, which may have the same names.
3742   ;; But first we handle single elements...
3743   (or (car (memq symbol params))
3744       ;; Handle alist.
3745       (let (elem)
3746         (catch 'found
3747           (while (setq elem (pop params))
3748             (when (and (consp elem)
3749                        (eq (car elem) symbol)
3750                        (or allow-list
3751                            (atom (cdr elem))))
3752               (throw 'found (if present-p (list (cdr elem))
3753                               (cdr elem)))))))))
3754
3755 (defun gnus-group-add-parameter (group param)
3756   "Add parameter PARAM to GROUP."
3757   (let ((info (gnus-get-info group)))
3758     (when info
3759       (gnus-group-remove-parameter group (if (consp param) (car param) param))
3760       ;; Cons the new param to the old one and update.
3761       (gnus-group-set-info (cons param (gnus-info-params info))
3762                            group 'params))))
3763
3764 (defun gnus-group-set-parameter (group name value)
3765   "Set parameter NAME to VALUE in GROUP."
3766   (let ((info (gnus-get-info group)))
3767     (when info
3768       (gnus-group-remove-parameter group name)
3769       (let ((old-params (gnus-info-params info))
3770             (new-params (list (cons name value))))
3771         (while old-params
3772           (when (or (not (listp (car old-params)))
3773                     (not (eq (caar old-params) name)))
3774             (setq new-params (append new-params (list (car old-params)))))
3775           (setq old-params (cdr old-params)))
3776         (gnus-group-set-info new-params group 'params)))))
3777
3778 (defun gnus-group-remove-parameter (group name)
3779   "Remove parameter NAME from GROUP."
3780   (let ((info (gnus-get-info group)))
3781     (when info
3782       (let ((params (gnus-info-params info)))
3783         (when params
3784           (setq params (delq name params))
3785           (while (assq name params)
3786             (gnus-pull name params))
3787           (gnus-info-set-params info params))))))
3788
3789 (defun gnus-group-add-score (group &optional score)
3790   "Add SCORE to the GROUP score.
3791 If SCORE is nil, add 1 to the score of GROUP."
3792   (let ((info (gnus-get-info group)))
3793     (when info
3794       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3795
3796 (defun gnus-short-group-name (group &optional levels)
3797   "Collapse GROUP name LEVELS.
3798 Select methods are stripped and any remote host name is stripped down to
3799 just the host name."
3800   (let* ((name "")
3801          (foreign "")
3802          (depth 0)
3803          (skip 1)
3804          (levels (or levels
3805                      gnus-group-uncollapsed-levels
3806                      (progn
3807                        (while (string-match "\\." group skip)
3808                          (setq skip (match-end 0)
3809                                depth (+ depth 1)))
3810                        depth))))
3811     ;; Separate foreign select method from group name and collapse.
3812     ;; If method contains a server, collapse to non-domain server name,
3813     ;; otherwise collapse to select method.
3814     (let* ((colon (string-match ":" group))
3815            (server (and colon (substring group 0 colon)))
3816            (plus (and server (string-match "+" server))))
3817       (when server
3818         (if plus
3819             (setq foreign (substring server (+ 1 plus)
3820                                      (string-match "\\." server))
3821                   group (substring group (+ 1 colon)))
3822           (setq foreign server
3823                 group (substring group (+ 1 colon))))
3824         (setq foreign (concat foreign ":")))
3825       ;; Collapse group name leaving LEVELS uncollapsed elements
3826       (let* ((slist (split-string group "/"))
3827              (slen (length slist))
3828              (dlist (split-string group "\\."))
3829              (dlen (length dlist))
3830              glist
3831              glen
3832              gsep
3833              res)
3834         (if (> slen dlen)
3835             (setq glist slist
3836                   glen slen
3837                   gsep "/")
3838           (setq glist dlist
3839                 glen dlen
3840                 gsep "."))
3841         (setq levels (- glen levels))
3842         (dolist (g glist)
3843           (push (if (>= (decf levels) 0)
3844                     (if (zerop (length g))
3845                         ""
3846                       (substring g 0 1))
3847                   g)
3848                 res))
3849         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3850
3851 (defun gnus-narrow-to-body ()
3852   "Narrow to the body of an article."
3853   (narrow-to-region
3854    (progn
3855      (goto-char (point-min))
3856      (or (search-forward "\n\n" nil t)
3857          (point-max)))
3858    (point-max)))
3859
3860 \f
3861 ;;;
3862 ;;; Kill file handling.
3863 ;;;
3864
3865 (defun gnus-apply-kill-file ()
3866   "Apply a kill file to the current newsgroup.
3867 Returns the number of articles marked as read."
3868   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3869           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3870       (gnus-apply-kill-file-internal)
3871     0))
3872
3873 (defun gnus-kill-save-kill-buffer ()
3874   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3875     (when (get-file-buffer file)
3876       (save-excursion
3877         (set-buffer (get-file-buffer file))
3878         (when (buffer-modified-p)
3879           (save-buffer))
3880         (kill-buffer (current-buffer))))))
3881
3882 (defcustom gnus-kill-file-name "KILL"
3883   "Suffix of the kill files."
3884   :group 'gnus-score-kill
3885   :group 'gnus-score-files
3886   :type 'string)
3887
3888 (defun gnus-newsgroup-kill-file (newsgroup)
3889   "Return the name of a kill file name for NEWSGROUP.
3890 If NEWSGROUP is nil, return the global kill file name instead."
3891   (cond
3892    ;; The global KILL file is placed at top of the directory.
3893    ((or (null newsgroup)
3894         (string-equal newsgroup ""))
3895     (expand-file-name gnus-kill-file-name
3896                       gnus-kill-files-directory))
3897    ;; Append ".KILL" to newsgroup name.
3898    ((gnus-use-long-file-name 'not-kill)
3899     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3900                               "." gnus-kill-file-name)
3901                       gnus-kill-files-directory))
3902    ;; Place "KILL" under the hierarchical directory.
3903    (t
3904     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3905                               "/" gnus-kill-file-name)
3906                       gnus-kill-files-directory))))
3907
3908 ;;; Server things.
3909
3910 (defun gnus-member-of-valid (symbol group)
3911   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3912   (memq symbol (assoc
3913                 (symbol-name (car (gnus-find-method-for-group group)))
3914                 gnus-valid-select-methods)))
3915
3916 (defun gnus-method-option-p (method option)
3917   "Return non-nil if select METHOD has OPTION as a parameter."
3918   (when (stringp method)
3919     (setq method (gnus-server-to-method method)))
3920   (memq option (assoc (format "%s" (car method))
3921                       gnus-valid-select-methods)))
3922
3923 (defun gnus-similar-server-opened (method)
3924   (let ((opened gnus-opened-servers))
3925     (while (and method opened)
3926       (when (and (equal (cadr method) (cadaar opened))
3927                  (equal (car method) (caaar opened))
3928                  (not (equal method (caar opened))))
3929         (setq method nil))
3930       (pop opened))
3931     (not method)))
3932
3933 (defun gnus-server-extend-method (group method)
3934   ;; This function "extends" a virtual server.  If the server is
3935   ;; "hello", and the select method is ("hello" (my-var "something"))
3936   ;; in the group "alt.alt", this will result in a new virtual server
3937   ;; called "hello+alt.alt".
3938   (if (or (not (inline (gnus-similar-server-opened method)))
3939           (not (cddr method)))
3940       method
3941     `(,(car method) ,(concat (cadr method) "+" group)
3942       (,(intern (format "%s-address" (car method))) ,(cadr method))
3943       ,@(cddr method))))
3944
3945 (defun gnus-server-status (method)
3946   "Return the status of METHOD."
3947   (nth 1 (assoc method gnus-opened-servers)))
3948
3949 (defun gnus-group-name-to-method (group)
3950   "Guess a select method based on GROUP."
3951   (if (string-match ":" group)
3952       (let ((server (substring group 0 (match-beginning 0))))
3953         (if (string-match "\\+" server)
3954             (list (intern (substring server 0 (match-beginning 0)))
3955                   (substring server (match-end 0)))
3956           (list (intern server) "")))
3957     gnus-select-method))
3958
3959 (defun gnus-server-string (server)
3960   "Return a readable string that describes SERVER."
3961   (let* ((server (gnus-server-to-method server))
3962          (address (nth 1 server)))
3963     (if (and address
3964              (not (zerop (length address))))
3965         (format "%s using %s" address (car server))
3966       (format "%s" (car server)))))
3967
3968 (defun gnus-find-method-for-group (group &optional info)
3969   "Find the select method that GROUP uses."
3970   (or gnus-override-method
3971       (and (not group)
3972            gnus-select-method)
3973       (and (not (gnus-group-entry group));; a new group
3974            (gnus-group-name-to-method group))
3975       (let ((info (or info (gnus-get-info group)))
3976             method)
3977         (if (or (not info)
3978                 (not (setq method (gnus-info-method info)))
3979                 (equal method "native"))
3980             gnus-select-method
3981           (setq method
3982                 (cond ((stringp method)
3983                        (inline (gnus-server-to-method method)))
3984                       ((stringp (cadr method))
3985                        (inline (gnus-server-extend-method group method)))
3986                       (t
3987                        method)))
3988           (cond ((equal (cadr method) "")
3989                  method)
3990                 ((null (cadr method))
3991                  (list (car method) ""))
3992                 (t
3993                  (gnus-server-add-address method)))))))
3994
3995 (defun gnus-methods-using (feature)
3996   "Find all methods that have FEATURE."
3997   (let ((valids gnus-valid-select-methods)
3998         outs)
3999     (while valids
4000       (when (memq feature (car valids))
4001         (push (car valids) outs))
4002       (setq valids (cdr valids)))
4003     outs))
4004
4005 (defun gnus-read-group (prompt &optional default)
4006   "Prompt the user for a group name.
4007 Disallow invalid group names."
4008   (let ((prefix "")
4009         group)
4010     (while (not group)
4011       (when (string-match
4012              gnus-invalid-group-regexp
4013              (setq group (read-string (concat prefix prompt)
4014                                       (cons (or default "") 0)
4015                                       'gnus-group-history)))
4016         (let ((match (match-string 0 group)))
4017           ;; Might be okay (e.g. for nnimap), so ask the user:
4018           (unless (and (not (string-match "^$\\|:" match))
4019                        (message-y-or-n-p
4020                         "Proceed and create group anyway? " t
4021 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4022
4023 Usually, it's dangerous to create a group with this name, because it's not
4024 supported by all back ends and servers.  On IMAP servers it should work,
4025 though.  If you are really sure, you can proceed anyway and create the group.
4026
4027 You may customize the variable `gnus-invalid-group-regexp', which currently is
4028 set to \"" gnus-invalid-group-regexp
4029 "\", if you want to get rid of this query permanently."))
4030             (setq prefix (format "Invalid group name: \"%s\".  " group)
4031                   group nil)))))
4032     group))
4033
4034 (defun gnus-read-method (prompt)
4035   "Prompt the user for a method.
4036 Allow completion over sensible values."
4037   (let* ((open-servers
4038           (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4039                   gnus-opened-servers))
4040          (valid-methods
4041           (let (methods)
4042             (dolist (method gnus-valid-select-methods)
4043               (if (or (memq 'prompt-address method)
4044                       (not (assoc (format "%s:" (car method)) open-servers)))
4045                   (push method methods)))
4046             methods))
4047          (servers
4048           (append valid-methods
4049                   open-servers
4050                   gnus-predefined-server-alist
4051                   gnus-server-alist))
4052          (method
4053           (completing-read
4054            prompt servers
4055            nil t nil 'gnus-method-history)))
4056     (cond
4057      ((equal method "")
4058       (setq method gnus-select-method))
4059      ((assoc method gnus-valid-select-methods)
4060       (let ((address (if (memq 'prompt-address
4061                                (assoc method gnus-valid-select-methods))
4062                          (read-string "Address: ")
4063                        "")))
4064         (or (cadr (assoc (format "%s:%s" method address) open-servers))
4065             (list (intern method) address))))
4066      ((assoc method servers)
4067       method)
4068      (t
4069       (list (intern method) "")))))
4070
4071 ;;; Agent functions
4072
4073 (defun gnus-agent-method-p (method)
4074   "Say whether METHOD is covered by the agent."
4075   (or (eq (car gnus-agent-method-p-cache) method)
4076       (setq gnus-agent-method-p-cache
4077             (cons method
4078                   (member (if (stringp method)
4079                               method
4080                             (gnus-method-to-server method)) gnus-agent-covered-methods))))
4081   (cdr gnus-agent-method-p-cache))
4082
4083 (defun gnus-online (method)
4084   (not
4085    (if gnus-plugged
4086        (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4087      (gnus-agent-method-p method))))
4088
4089 ;;; User-level commands.
4090
4091 ;;;###autoload
4092 (defun gnus-slave-no-server (&optional arg)
4093   "Read network news as a slave, without connecting to the local server."
4094   (interactive "P")
4095   (gnus-no-server arg t))
4096
4097 ;;;###autoload
4098 (defun gnus-no-server (&optional arg slave)
4099   "Read network news.
4100 If ARG is a positive number, Gnus will use that as the startup
4101 level. If ARG is nil, Gnus will be started at level 2.  If ARG is
4102 non-nil and not a positive number, Gnus will prompt the user for the
4103 name of an NNTP server to use.
4104 As opposed to `gnus', this command will not connect to the local
4105 server."
4106   (interactive "P")
4107   (gnus-no-server-1 arg slave))
4108
4109 ;;;###autoload
4110 (defun gnus-slave (&optional arg)
4111   "Read news as a slave."
4112   (interactive "P")
4113   (gnus arg nil 'slave))
4114
4115 (defcustom gnus-frame-properties nil
4116   "The properties of the frame in which gnus is displayed. Under XEmacs,
4117 the variable `toolbar-news-frame-plist' will be refered instead."
4118   :type '(repeat (cons :format "%v"
4119                        (symbol :tag "Parameter")
4120                        (sexp :tag "Value")))
4121   :group 'gnus)
4122
4123 ;;;###autoload
4124 (defun gnus-other-frame (&optional arg display)
4125   "Pop up a frame to read news.
4126 This will call one of the Gnus commands which is specified by the user
4127 option `gnus-other-frame-function' (default `gnus') with the argument
4128 ARG if Gnus is not running, otherwise just pop up a Gnus frame.  The
4129 optional second argument DISPLAY should be a standard display string
4130 such as \"unix:0\" to specify where to pop up a frame.  If DISPLAY is
4131 omitted or the function `make-frame-on-display' is not available, the
4132 current display is used."
4133   (interactive "P")
4134   (if (fboundp 'make-frame-on-display)
4135       (unless display
4136         (setq display (gnus-frame-or-window-display-name (selected-frame))))
4137     (setq display nil))
4138   (let ((alive (gnus-alive-p)))
4139     (unless (and alive
4140                  (catch 'found
4141                    (walk-windows
4142                     (lambda (window)
4143                       (when (and (or (not display)
4144                                      (equal display
4145                                             (gnus-frame-or-window-display-name
4146                                              window)))
4147                                  (with-current-buffer (window-buffer window)
4148                                    (string-match "\\`gnus-"
4149                                                  (symbol-name major-mode))))
4150                         (gnus-select-frame-set-input-focus
4151                          (setq gnus-other-frame-object (window-frame window)))
4152                         (select-window window)
4153                         (throw 'found t)))
4154                     'ignore t)))
4155       (gnus-select-frame-set-input-focus
4156        (setq gnus-other-frame-object
4157              (if display
4158                  (make-frame-on-display display gnus-other-frame-parameters)
4159                (make-frame gnus-other-frame-parameters))))
4160       (if alive
4161           (switch-to-buffer gnus-group-buffer)
4162         (funcall gnus-other-frame-function arg)
4163         (add-hook 'gnus-exit-gnus-hook
4164                   '(lambda nil
4165                      (when (and (frame-live-p gnus-other-frame-object)
4166                                 (cdr (frame-list)))
4167                        (delete-frame gnus-other-frame-object))
4168                      (setq gnus-other-frame-object nil)))))))
4169
4170 ;;;###autoload
4171 (defun gnus (&optional arg dont-connect slave)
4172   "Read network news.
4173 If ARG is non-nil and a positive number, Gnus will use that as the
4174 startup level.  If ARG is non-nil and not a positive number, Gnus will
4175 prompt the user for the name of an NNTP server to use."
4176   (interactive "P")
4177   (unless (byte-code-function-p (symbol-function 'gnus))
4178     (message "You should byte-compile Gnus")
4179     (sit-for 2))
4180   (gnus-1 arg dont-connect slave))
4181
4182 ;; Allow redefinition of Gnus functions.
4183
4184 (gnus-ems-redefine)
4185
4186 (product-provide (provide 'gnus) 'gnus-vers)
4187
4188 ;;; gnus.el ends here