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