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