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

   1 ;;; gnus.el --- a newsreader for GNU Emacs
   2 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996,
   3 ;;        1997, 1998, 2000 Free Software Foundation, Inc.
   4
   5 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
   6 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
   7 ;;      Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
   8 ;;      Yoshiki Hayashi <t90553@mail.ecc.u-tokyo.ac.jp>
   9 ;; Keywords: news, mail
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; GNU Emacs is free software; you can redistribute it and/or modify
  14 ;; it under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation; either version 2, or (at your option)
  16 ;; any later version.
  17
  18 ;; GNU Emacs is distributed in the hope that it will be useful,
  19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 ;; GNU General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  26 ;; Boston, MA 02111-1307, USA.
  27
  28 ;;; Commentary:
  29
  30 ;;; Code:
  31
  32 (eval '(run-hooks 'gnus-load-hook))
  33
  34 (eval-when-compile (require 'cl))
  35 (eval-when-compile (require 'static))
  36
  37 (require 'gnus-vers)
  38 (require 'message)
  39
  40 (defgroup gnus nil
  41   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
  42   :group 'news
  43   :group 'mail)
  44
  45 (defgroup gnus-charset nil
  46   "Group character set issues."
  47   :link '(custom-manual "(gnus)Charsets")
  48   :group 'gnus)
  49
  50 (defgroup gnus-cache nil
  51   "Cache interface."
  52   :group 'gnus)
  53
  54 (defgroup gnus-start nil
  55   "Starting your favorite newsreader."
  56   :group 'gnus)
  57
  58 (defgroup gnus-start-server nil
  59   "Server options at startup."
  60   :group 'gnus-start)
  61
  62 ;; These belong to gnus-group.el.
  63 (defgroup gnus-group nil
  64   "Group buffers."
  65   :link '(custom-manual "(gnus)The Group Buffer")
  66   :group 'gnus)
  67
  68 (defgroup gnus-group-foreign nil
  69   "Foreign groups."
  70   :link '(custom-manual "(gnus)Foreign Groups")
  71   :group 'gnus-group)
  72
  73 (defgroup gnus-group-new nil
  74   "Automatic subscription of new groups."
  75   :group 'gnus-group)
  76
  77 (defgroup gnus-group-levels nil
  78   "Group levels."
  79   :link '(custom-manual "(gnus)Group Levels")
  80   :group 'gnus-group)
  81
  82 (defgroup gnus-group-select nil
  83   "Selecting a Group."
  84   :link '(custom-manual "(gnus)Selecting a Group")
  85   :group 'gnus-group)
  86
  87 (defgroup gnus-group-listing nil
  88   "Showing slices of the group list."
  89   :link '(custom-manual "(gnus)Listing Groups")
  90   :group 'gnus-group)
  91
  92 (defgroup gnus-group-visual nil
  93   "Sorting the group buffer."
  94   :link '(custom-manual "(gnus)Group Buffer Format")
  95   :group 'gnus-group
  96   :group 'gnus-visual)
  97
  98 (defgroup gnus-group-various nil
  99   "Various group options."
 100   :link '(custom-manual "(gnus)Scanning New Messages")
 101   :group 'gnus-group)
 102
 103 ;; These belong to gnus-sum.el.
 104 (defgroup gnus-summary nil
 105   "Summary buffers."
 106   :link '(custom-manual "(gnus)The Summary Buffer")
 107   :group 'gnus)
 108
 109 (defgroup gnus-summary-exit nil
 110   "Leaving summary buffers."
 111   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
 112   :group 'gnus-summary)
 113
 114 (defgroup gnus-summary-marks nil
 115   "Marks used in summary buffers."
 116   :link '(custom-manual "(gnus)Marking Articles")
 117   :group 'gnus-summary)
 118
 119 (defgroup gnus-thread nil
 120   "Ordering articles according to replies."
 121   :link '(custom-manual "(gnus)Threading")
 122   :group 'gnus-summary)
 123
 124 (defgroup gnus-summary-format nil
 125   "Formatting of the summary buffer."
 126   :link '(custom-manual "(gnus)Summary Buffer Format")
 127   :group 'gnus-summary)
 128
 129 (defgroup gnus-summary-choose nil
 130   "Choosing Articles."
 131   :link '(custom-manual "(gnus)Choosing Articles")
 132   :group 'gnus-summary)
 133
 134 (defgroup gnus-summary-maneuvering nil
 135   "Summary movement commands."
 136   :link '(custom-manual "(gnus)Summary Maneuvering")
 137   :group 'gnus-summary)
 138
 139 (defgroup gnus-summary-mail nil
 140   "Mail group commands."
 141   :link '(custom-manual "(gnus)Mail Group Commands")
 142   :group 'gnus-summary)
 143
 144 (defgroup gnus-summary-sort nil
 145   "Sorting the summary buffer."
 146   :link '(custom-manual "(gnus)Sorting")
 147   :group 'gnus-summary)
 148
 149 (defgroup gnus-summary-visual nil
 150   "Highlighting and menus in the summary buffer."
 151   :link '(custom-manual "(gnus)Summary Highlighting")
 152   :group 'gnus-visual
 153   :group 'gnus-summary)
 154
 155 (defgroup gnus-summary-various nil
 156   "Various summary buffer options."
 157   :link '(custom-manual "(gnus)Various Summary Stuff")
 158   :group 'gnus-summary)
 159
 160 (defgroup gnus-summary-pick nil
 161   "Pick mode in the summary buffer."
 162   :link '(custom-manual "(gnus)Pick and Read")
 163   :prefix "gnus-pick-"
 164   :group 'gnus-summary)
 165
 166 (defgroup gnus-summary-tree nil
 167   "Tree display of threads in the summary buffer."
 168   :link '(custom-manual "(gnus)Tree Display")
 169   :prefix "gnus-tree-"
 170   :group 'gnus-summary)
 171
 172 ;; Belongs to gnus-uu.el
 173 (defgroup gnus-extract-view nil
 174   "Viewing extracted files."
 175   :link '(custom-manual "(gnus)Viewing Files")
 176   :group 'gnus-extract)
 177
 178 ;; Belongs to gnus-score.el
 179 (defgroup gnus-score nil
 180   "Score and kill file handling."
 181   :group 'gnus)
 182
 183 (defgroup gnus-score-kill nil
 184   "Kill files."
 185   :group 'gnus-score)
 186
 187 (defgroup gnus-score-adapt nil
 188   "Adaptive score files."
 189   :group 'gnus-score)
 190
 191 (defgroup gnus-score-default nil
 192   "Default values for score files."
 193   :group 'gnus-score)
 194
 195 (defgroup gnus-score-expire nil
 196   "Expiring score rules."
 197   :group 'gnus-score)
 198
 199 (defgroup gnus-score-decay nil
 200   "Decaying score rules."
 201   :group 'gnus-score)
 202
 203 (defgroup gnus-score-files nil
 204   "Score and kill file names."
 205   :group 'gnus-score
 206   :group 'gnus-files)
 207
 208 (defgroup gnus-score-various nil
 209   "Various scoring and killing options."
 210   :group 'gnus-score)
 211
 212 ;; Other
 213 (defgroup gnus-visual nil
 214   "Options controling the visual fluff."
 215   :group 'gnus
 216   :group 'faces)
 217
 218 (defgroup gnus-agent nil
 219   "Offline support for Gnus."
 220   :group 'gnus)
 221
 222 (defgroup gnus-files nil
 223   "Files used by Gnus."
 224   :group 'gnus)
 225
 226 (defgroup gnus-dribble-file nil
 227   "Auto save file."
 228   :link '(custom-manual "(gnus)Auto Save")
 229   :group 'gnus-files)
 230
 231 (defgroup gnus-newsrc nil
 232   "Storing Gnus state."
 233   :group 'gnus-files)
 234
 235 (defgroup gnus-server nil
 236   "Options related to newsservers and other servers used by Gnus."
 237   :group 'gnus)
 238
 239 (defgroup gnus-message '((message custom-group))
 240   "Composing replies and followups in Gnus."
 241   :group 'gnus)
 242
 243 (defgroup gnus-meta nil
 244   "Meta variables controling major portions of Gnus.
 245 In general, modifying these variables does not take affect until Gnus
 246 is restarted, and sometimes reloaded."
 247   :group 'gnus)
 248
 249 (defgroup gnus-various nil
 250   "Other Gnus options."
 251   :link '(custom-manual "(gnus)Various Various")
 252   :group 'gnus)
 253
 254 (defgroup gnus-mime nil
 255   "Variables for controlling the Gnus MIME interface."
 256   :group 'gnus)
 257
 258 (defgroup gnus-exit nil
 259   "Exiting gnus."
 260   :link '(custom-manual "(gnus)Exiting Gnus")
 261   :group 'gnus)
 262
 263 (defcustom gnus-inhibit-startup-message nil
 264   "If non-nil, the startup message will not be displayed.
 265 This variable is used before `.gnus.el' is loaded, so it should
 266 be set in `.emacs' instead."
 267   :group 'gnus-start
 268   :type 'boolean)
 269
 270 (defcustom gnus-play-startup-jingle nil
 271   "If non-nil, play the Gnus jingle at startup."
 272   :group 'gnus-start
 273   :type 'boolean)
 274
 275 (unless (featurep 'gnus-xmas)
 276   (defalias 'gnus-make-overlay 'make-overlay)
 277   (defalias 'gnus-delete-overlay 'delete-overlay)
 278   (defalias 'gnus-overlay-put 'overlay-put)
 279   (defalias 'gnus-move-overlay 'move-overlay)
 280   (defalias 'gnus-overlay-end 'overlay-end)
 281   (defalias 'gnus-extent-detached-p 'ignore)
 282   (defalias 'gnus-extent-start-open 'ignore)
 283   (defalias 'gnus-set-text-properties 'set-text-properties)
 284   (defalias 'gnus-group-remove-excess-properties 'ignore)
 285   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
 286   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
 287   (defalias 'gnus-character-to-event 'identity)
 288   (defalias 'gnus-add-text-properties 'add-text-properties)
 289   (defalias 'gnus-put-text-property 'put-text-property)
 290   (defalias 'gnus-mode-line-buffer-identification 'identity)
 291   (defalias 'gnus-characterp 'numberp)
 292   (defalias 'gnus-deactivate-mark 'deactivate-mark)
 293   (defalias 'gnus-window-edges 'window-edges)
 294   (defalias 'gnus-key-press-event-p 'numberp)
 295   (defalias 'gnus-decode-rfc1522 'ignore))
 296
 297 ;; We define these group faces here to avoid the display
 298 ;; update forced when creating new faces.
 299
 300 (defface gnus-group-news-1-face
 301   '((((class color)
 302       (background dark))
 303      (:foreground "PaleTurquoise" :bold t))
 304     (((class color)
 305       (background light))
 306      (:foreground "ForestGreen" :bold t))
 307     (t
 308      ()))
 309   "Level 1 newsgroup face.")
 310
 311 (defface gnus-group-news-1-empty-face
 312   '((((class color)
 313       (background dark))
 314      (:foreground "PaleTurquoise"))
 315     (((class color)
 316       (background light))
 317      (:foreground "ForestGreen"))
 318     (t
 319      ()))
 320   "Level 1 empty newsgroup face.")
 321
 322 (defface gnus-group-news-2-face
 323   '((((class color)
 324       (background dark))
 325      (:foreground "turquoise" :bold t))
 326     (((class color)
 327       (background light))
 328      (:foreground "CadetBlue4" :bold t))
 329     (t
 330      ()))
 331   "Level 2 newsgroup face.")
 332
 333 (defface gnus-group-news-2-empty-face
 334   '((((class color)
 335       (background dark))
 336      (:foreground "turquoise"))
 337     (((class color)
 338       (background light))
 339      (:foreground "CadetBlue4"))
 340     (t
 341      ()))
 342   "Level 2 empty newsgroup face.")
 343
 344 (defface gnus-group-news-3-face
 345   '((((class color)
 346       (background dark))
 347      (:bold t))
 348     (((class color)
 349       (background light))
 350      (:bold t))
 351     (t
 352      ()))
 353   "Level 3 newsgroup face.")
 354
 355 (defface gnus-group-news-3-empty-face
 356   '((((class color)
 357       (background dark))
 358      ())
 359     (((class color)
 360       (background light))
 361      ())
 362     (t
 363      ()))
 364   "Level 3 empty newsgroup face.")
 365
 366 (defface gnus-group-news-4-face
 367   '((((class color)
 368       (background dark))
 369      (:bold t))
 370     (((class color)
 371       (background light))
 372      (:bold t))
 373     (t
 374      ()))
 375   "Level 4 newsgroup face.")
 376
 377 (defface gnus-group-news-4-empty-face
 378   '((((class color)
 379       (background dark))
 380      ())
 381     (((class color)
 382       (background light))
 383      ())
 384     (t
 385      ()))
 386   "Level 4 empty newsgroup face.")
 387
 388 (defface gnus-group-news-5-face
 389   '((((class color)
 390       (background dark))
 391      (:bold t))
 392     (((class color)
 393       (background light))
 394      (:bold t))
 395     (t
 396      ()))
 397   "Level 5 newsgroup face.")
 398
 399 (defface gnus-group-news-5-empty-face
 400   '((((class color)
 401       (background dark))
 402      ())
 403     (((class color)
 404       (background light))
 405      ())
 406     (t
 407      ()))
 408   "Level 5 empty newsgroup face.")
 409
 410 (defface gnus-group-news-6-face
 411   '((((class color)
 412       (background dark))
 413      (:bold t))
 414     (((class color)
 415       (background light))
 416      (:bold t))
 417     (t
 418      ()))
 419   "Level 6 newsgroup face.")
 420
 421 (defface gnus-group-news-6-empty-face
 422   '((((class color)
 423       (background dark))
 424      ())
 425     (((class color)
 426       (background light))
 427      ())
 428     (t
 429      ()))
 430   "Level 6 empty newsgroup face.")
 431
 432 (defface gnus-group-news-low-face
 433   '((((class color)
 434       (background dark))
 435      (:foreground "DarkTurquoise" :bold t))
 436     (((class color)
 437       (background light))
 438      (:foreground "DarkGreen" :bold t))
 439     (t
 440      ()))
 441   "Low level newsgroup face.")
 442
 443 (defface gnus-group-news-low-empty-face
 444   '((((class color)
 445       (background dark))
 446      (:foreground "DarkTurquoise"))
 447     (((class color)
 448       (background light))
 449      (:foreground "DarkGreen"))
 450     (t
 451      ()))
 452   "Low level empty newsgroup face.")
 453
 454 (defface gnus-group-mail-1-face
 455   '((((class color)
 456       (background dark))
 457      (:foreground "aquamarine1" :bold t))
 458     (((class color)
 459       (background light))
 460      (:foreground "DeepPink3" :bold t))
 461     (t
 462      (:bold t)))
 463   "Level 1 mailgroup face.")
 464
 465 (defface gnus-group-mail-1-empty-face
 466   '((((class color)
 467       (background dark))
 468      (:foreground "aquamarine1"))
 469     (((class color)
 470       (background light))
 471      (:foreground "DeepPink3"))
 472     (t
 473      (:italic t :bold t)))
 474   "Level 1 empty mailgroup face.")
 475
 476 (defface gnus-group-mail-2-face
 477   '((((class color)
 478       (background dark))
 479      (:foreground "aquamarine2" :bold t))
 480     (((class color)
 481       (background light))
 482      (:foreground "HotPink3" :bold t))
 483     (t
 484      (:bold t)))
 485   "Level 2 mailgroup face.")
 486
 487 (defface gnus-group-mail-2-empty-face
 488   '((((class color)
 489       (background dark))
 490      (:foreground "aquamarine2"))
 491     (((class color)
 492       (background light))
 493      (:foreground "HotPink3"))
 494     (t
 495      (:bold t)))
 496   "Level 2 empty mailgroup face.")
 497
 498 (defface gnus-group-mail-3-face
 499   '((((class color)
 500       (background dark))
 501      (:foreground "aquamarine3" :bold t))
 502     (((class color)
 503       (background light))
 504      (:foreground "magenta4" :bold t))
 505     (t
 506      (:bold t)))
 507   "Level 3 mailgroup face.")
 508
 509 (defface gnus-group-mail-3-empty-face
 510   '((((class color)
 511       (background dark))
 512      (:foreground "aquamarine3"))
 513     (((class color)
 514       (background light))
 515      (:foreground "magenta4"))
 516     (t
 517      ()))
 518   "Level 3 empty mailgroup face.")
 519
 520 (defface gnus-group-mail-low-face
 521   '((((class color)
 522       (background dark))
 523      (:foreground "aquamarine4" :bold t))
 524     (((class color)
 525       (background light))
 526      (:foreground "DeepPink4" :bold t))
 527     (t
 528      (:bold t)))
 529   "Low level mailgroup face.")
 530
 531 (defface gnus-group-mail-low-empty-face
 532   '((((class color)
 533       (background dark))
 534      (:foreground "aquamarine4"))
 535     (((class color)
 536       (background light))
 537      (:foreground "DeepPink4"))
 538     (t
 539      (:bold t)))
 540   "Low level empty mailgroup face.")
 541
 542 ;; Summary mode faces.
 543
 544 (defface gnus-summary-selected-face '((t
 545                                        (:underline t)))
 546   "Face used for selected articles.")
 547
 548 (defface gnus-summary-cancelled-face
 549   '((((class color))
 550      (:foreground "yellow" :background "black")))
 551   "Face used for cancelled articles.")
 552
 553 (defface gnus-summary-high-ticked-face
 554   '((((class color)
 555       (background dark))
 556      (:foreground "pink" :bold t))
 557     (((class color)
 558       (background light))
 559      (:foreground "firebrick" :bold t))
 560     (t
 561      (:bold t)))
 562   "Face used for high interest ticked articles.")
 563
 564 (defface gnus-summary-low-ticked-face
 565   '((((class color)
 566       (background dark))
 567      (:foreground "pink" :italic t))
 568     (((class color)
 569       (background light))
 570      (:foreground "firebrick" :italic t))
 571     (t
 572      (:italic t)))
 573   "Face used for low interest ticked articles.")
 574
 575 (defface gnus-summary-normal-ticked-face
 576   '((((class color)
 577       (background dark))
 578      (:foreground "pink"))
 579     (((class color)
 580       (background light))
 581      (:foreground "firebrick"))
 582     (t
 583      ()))
 584   "Face used for normal interest ticked articles.")
 585
 586 (defface gnus-summary-high-ancient-face
 587   '((((class color)
 588       (background dark))
 589      (:foreground "SkyBlue" :bold t))
 590     (((class color)
 591       (background light))
 592      (:foreground "RoyalBlue" :bold t))
 593     (t
 594      (:bold t)))
 595   "Face used for high interest ancient articles.")
 596
 597 (defface gnus-summary-low-ancient-face
 598   '((((class color)
 599       (background dark))
 600      (:foreground "SkyBlue" :italic t))
 601     (((class color)
 602       (background light))
 603      (:foreground "RoyalBlue" :italic t))
 604     (t
 605      (:italic t)))
 606   "Face used for low interest ancient articles.")
 607
 608 (defface gnus-summary-normal-ancient-face
 609   '((((class color)
 610       (background dark))
 611      (:foreground "SkyBlue"))
 612     (((class color)
 613       (background light))
 614      (:foreground "RoyalBlue"))
 615     (t
 616      ()))
 617   "Face used for normal interest ancient articles.")
 618
 619 (defface gnus-summary-high-unread-face
 620   '((t
 621      (:bold t)))
 622   "Face used for high interest unread articles.")
 623
 624 (defface gnus-summary-low-unread-face
 625   '((t
 626      (:italic t)))
 627   "Face used for low interest unread articles.")
 628
 629 (defface gnus-summary-normal-unread-face
 630   '((t
 631      ()))
 632   "Face used for normal interest unread articles.")
 633
 634 (defface gnus-summary-incorporated-face
 635   '((t
 636      ()))
 637   "Face used for incorporated articles.")
 638
 639 (defface gnus-summary-high-read-face
 640   '((((class color)
 641       (background dark))
 642      (:foreground "PaleGreen"
 643                   :bold t))
 644     (((class color)
 645       (background light))
 646      (:foreground "DarkGreen"
 647                   :bold t))
 648     (t
 649      (:bold t)))
 650   "Face used for high interest read articles.")
 651
 652 (defface gnus-summary-low-read-face
 653   '((((class color)
 654       (background dark))
 655      (:foreground "PaleGreen"
 656                   :italic t))
 657     (((class color)
 658       (background light))
 659      (:foreground "DarkGreen"
 660                   :italic t))
 661     (t
 662      (:italic t)))
 663   "Face used for low interest read articles.")
 664
 665 (defface gnus-summary-normal-read-face
 666   '((((class color)
 667       (background dark))
 668      (:foreground "PaleGreen"))
 669     (((class color)
 670       (background light))
 671      (:foreground "DarkGreen"))
 672     (t
 673      ()))
 674   "Face used for normal interest read articles.")
 675
 676
 677 ;;;
 678 ;;; Gnus buffers
 679 ;;;
 680
 681 (defvar gnus-buffers nil)
 682
 683 (defun gnus-get-buffer-create (name)
 684   "Do the same as `get-buffer-create', but store the created buffer."
 685   (or (get-buffer name)
 686       (car (push (get-buffer-create name) gnus-buffers))))
 687
 688 (defun gnus-add-buffer ()
 689   "Add the current buffer to the list of Gnus buffers."
 690   (push (current-buffer) gnus-buffers))
 691
 692 (defun gnus-buffers ()
 693   "Return a list of live Gnus buffers."
 694   (while (and gnus-buffers
 695               (not (buffer-name (car gnus-buffers))))
 696     (pop gnus-buffers))
 697   (let ((buffers gnus-buffers))
 698     (while (cdr buffers)
 699       (if (buffer-name (cadr buffers))
 700           (pop buffers)
 701         (setcdr buffers (cddr buffers)))))
 702   gnus-buffers)
 703
 704 ;;; Splash screen.
 705
 706 (defvar gnus-group-buffer "*Group*")
 707
 708 (eval-and-compile
 709   (autoload 'gnus-play-jingle "gnus-audio"))
 710
 711 (defface gnus-splash-face
 712   '((((class color)
 713       (background dark))
 714      (:foreground "Brown"))
 715     (((class color)
 716       (background light))
 717      (:foreground "Brown"))
 718     (t
 719      ()))
 720   "Face of the splash screen.")
 721
 722 (defun gnus-splash ()
 723   (save-excursion
 724     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
 725     (let ((buffer-read-only nil))
 726       (erase-buffer)
 727       (unless gnus-inhibit-startup-message
 728         (gnus-group-startup-message)
 729         (sit-for 0)
 730         (when gnus-play-startup-jingle
 731           (gnus-play-jingle))))))
 732
 733 (defun gnus-indent-rigidly (start end arg)
 734   "Indent rigidly using only spaces and no tabs."
 735   (save-excursion
 736     (save-restriction
 737       (narrow-to-region start end)
 738       (let ((tab-width 8))
 739         (indent-rigidly start end arg)
 740         ;; We translate tabs into spaces -- not everybody uses
 741         ;; an 8-character tab.
 742         (goto-char (point-min))
 743         (while (search-forward "\t" nil t)
 744           (replace-match "        " t t))))))
 745
 746 (defvar gnus-simple-splash nil)
 747
 748 (defun gnus-group-startup-message (&optional x y)
 749   "Insert startup message in current buffer."
 750   ;; Insert the message.
 751   (erase-buffer)
 752   (cond
 753    ((and (fboundp 'find-image)
 754          (display-graphic-p)
 755          (let ((image
 756                 (find-image
 757                  `((:type xpm :file "gnus.xpm"
 758                           :color-symbols
 759                           (("thing" . "#724214")
 760                            ("shadow" . "#1e3f03")
 761                            ("background" . ,(face-background 'default))))
 762                    (:type xbm :file "gnus.xbm"
 763                           :foreground ,(face-foreground 'gnus-splash-face)
 764                           :background ,(face-background 'default))))))
 765            (when image
 766              (insert-image image)
 767              (goto-char (point-min))
 768              (insert-char
 769               ?\ ;; space
 770               (max 0 (let ((cw (frame-char-width)))
 771                        (/ (+ (- (* (window-width) cw) 271) cw) 2 cw))))
 772              (goto-char (point-min))
 773              (insert gnus-product-name " " gnus-version-number
 774                      (if (zerop (string-to-number gnus-revision-number))
 775                          ""
 776                        (concat " (r" gnus-revision-number ")"))
 777                      " based on " gnus-original-product-name " v"
 778                      gnus-original-version-number "\n")
 779              (goto-char (point-min))
 780              (put-text-property (point) (gnus-point-at-eol)
 781                                 'face 'gnus-splash-face)
 782              (insert-char ?\ ;; space
 783                           (max 0 (/ (- (window-width) (gnus-point-at-eol)) 2)))
 784              (forward-line 1)
 785              (insert-char
 786               ?\n (max 0
 787                        (let ((ch (frame-char-height)))
 788                          (/ (+ (- (* (1- (window-height)) ch) 273) ch) 2 ch))))
 789              (setq gnus-simple-splash nil)
 790              t))))
 791    (t
 792     (insert "
 793           _    ___ _             _
 794           _ ___ __ ___  __    _ ___
 795           __   _     ___    __  ___
 796               _           ___     _
 797              _  _ __             _
 798              ___   __            _
 799                    __           _
 800                     _      _   _
 801                    _      _    _
 802                       _  _    _
 803                   __  ___
 804                  _   _ _     _
 805                 _   _
 806               _    _
 807              _    _
 808             _
 809           __
 810
 811 "
 812             )
 813     (goto-char (point-min))
 814     (insert gnus-product-name " " gnus-version-number
 815             (if (zerop (string-to-number gnus-revision-number))
 816                 ""
 817               (concat " (r" gnus-revision-number ")"))
 818             " based on " gnus-original-product-name " v"
 819             gnus-original-version-number)
 820     (goto-char (point-min))
 821     (insert-char ?\ ; space
 822                  (max 0 (/ (- (window-width) (gnus-point-at-eol)) 2)))
 823     (forward-line 1)
 824     ;; And then hack it.
 825     (gnus-indent-rigidly (point) (point-max)
 826                          (/ (max (- (window-width) (or x 46)) 0) 2))
 827     (goto-char (point-min))
 828     (forward-line 1)
 829     (let* ((pheight (count-lines (point-min) (point-max)))
 830            (wheight (window-height))
 831            (rest (- wheight pheight)))
 832       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
 833     ;; Fontify some.
 834     (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
 835     (setq gnus-simple-splash t)))
 836   (goto-char (point-min))
 837   (setq mode-line-buffer-identification (concat " " gnus-version))
 838   (set-buffer-modified-p t))
 839
 840 (eval-when (load)
 841   (let ((command (format "%s" this-command)))
 842     (if (and (string-match "gnus" command)
 843              (not (string-match "gnus-other-frame" command)))
 844         (gnus-splash)
 845       (gnus-get-buffer-create gnus-group-buffer))))
 846
 847 ;;; Do the rest.
 848
 849 (require 'custom)
 850 (require 'gnus-util)
 851 (require 'nnheader)
 852
 853 (defcustom gnus-home-directory "~/"
 854   "Directory variable that specifies the \"home\" directory.
 855 All other Gnus path variables are initialized from this variable."
 856   :group 'gnus-files
 857   :type 'directory)
 858
 859 (defcustom gnus-directory (or (getenv "SAVEDIR")
 860                               (nnheader-concat gnus-home-directory "News/"))
 861   "*Directory variable from which all other Gnus file variables are derived.
 862
 863 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
 864 This means that other directory variables that are initialized from
 865 this variable won't be set properly if you set this variable in `.gnus.el'.
 866 Set this variable in `.emacs' instead."
 867   :group 'gnus-files
 868   :type 'directory)
 869
 870 (defcustom gnus-default-directory nil
 871   "*Default directory for all Gnus buffers."
 872   :group 'gnus-files
 873   :type '(choice (const :tag "current" nil)
 874                  directory))
 875
 876 ;; Site dependent variables.  These variables should be defined in
 877 ;; paths.el.
 878
 879 (defvar gnus-default-nntp-server nil
 880   "Specify a default NNTP server.
 881 This variable should be defined in paths.el, and should never be set
 882 by the user.
 883 If you want to change servers, you should use `gnus-select-method'.
 884 See the documentation to that variable.")
 885
 886 ;; Don't touch this variable.
 887 (defvar gnus-nntp-service "nntp"
 888   "NNTP service name (\"nntp\" or 119).
 889 This is an obsolete variable, which is scarcely used.  If you use an
 890 nntp server for your newsgroup and want to change the port number
 891 used to 899, you would say something along these lines:
 892
 893  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
 894
 895 (defcustom gnus-nntpserver-file "/etc/nntpserver"
 896   "A file with only the name of the nntp server in it."
 897   :group 'gnus-files
 898   :group 'gnus-server
 899   :type 'file)
 900
 901 ;; This function is used to check both the environment variable
 902 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
 903 ;; an nntp server name default.
 904 (defun gnus-getenv-nntpserver ()
 905   (or (getenv "NNTPSERVER")
 906       (and (file-readable-p gnus-nntpserver-file)
 907            (save-excursion
 908              (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
 909              (insert-file-contents gnus-nntpserver-file)
 910              (let ((name (buffer-string)))
 911                (prog1
 912                    (if (string-match "\\'[ \t\n]*$" name)
 913                        nil
 914                      name)
 915                  (kill-buffer (current-buffer))))))))
 916
 917 (defcustom gnus-select-method
 918   (condition-case nil
 919       (nconc
 920        (list 'nntp (or (condition-case nil
 921                            (gnus-getenv-nntpserver)
 922                          (error nil))
 923                        (when (and gnus-default-nntp-server
 924                                   (not (string= gnus-default-nntp-server "")))
 925                          gnus-default-nntp-server)
 926                        "news"))
 927        (if (or (null gnus-nntp-service)
 928                (equal gnus-nntp-service "nntp"))
 929            nil
 930          (list gnus-nntp-service)))
 931     (error nil))
 932   "Default method for selecting a newsgroup.
 933 This variable should be a list, where the first element is how the
 934 news is to be fetched, the second is the address.
 935
 936 For instance, if you want to get your news via NNTP from
 937 \"flab.flab.edu\", you could say:
 938
 939 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
 940
 941 If you want to use your local spool, say:
 942
 943 \(setq gnus-select-method (list 'nnspool (system-name)))
 944
 945 If you use this variable, you must set `gnus-nntp-server' to nil.
 946
 947 There is a lot more to know about select methods and virtual servers -
 948 see the manual for details."
 949   :group 'gnus-server
 950   :type 'gnus-select-method)
 951
 952 (defcustom gnus-message-archive-method
 953   `(nnfolder
 954     "archive"
 955     (nnfolder-directory ,(nnheader-concat message-directory "archive"))
 956     (nnfolder-active-file
 957      ,(nnheader-concat message-directory "archive/active"))
 958     (nnfolder-get-new-mail nil)
 959     (nnfolder-inhibit-expiry t))
 960   "*Method used for archiving messages you've sent.
 961 This should be a mail method.
 962
 963 It's probably not very effective to change this variable once you've
 964 run Gnus once.  After doing that, you must edit this server from the
 965 server buffer."
 966   :group 'gnus-server
 967   :group 'gnus-message
 968   :type 'gnus-select-method)
 969
 970 (defcustom gnus-message-archive-group nil
 971   "*Name of the group in which to save the messages you've written.
 972 This can either be a string; a list of strings; or an alist
 973 of regexps/functions/forms to be evaluated to return a string (or a list
 974 of strings).  The functions are called with the name of the current
 975 group (or nil) as a parameter.
 976
 977 If you want to save your mail in one group and the news articles you
 978 write in another group, you could say something like:
 979
 980  \(setq gnus-message-archive-group
 981         '((if (message-news-p)
 982               \"misc-news\"
 983             \"misc-mail\")))
 984
 985 Normally the group names returned by this variable should be
 986 unprefixed -- which implicitly means \"store on the archive server\".
 987 However, you may wish to store the message on some other server.  In
 988 that case, just return a fully prefixed name of the group --
 989 \"nnml+private:mail.misc\", for instance."
 990   :group 'gnus-message
 991   :type '(choice (const :tag "none" nil)
 992                  function
 993                  sexp
 994                  string))
 995
 996 (defcustom gnus-secondary-servers nil
 997   "List of NNTP servers that the user can choose between interactively.
 998 To make Gnus query you for a server, you have to give `gnus' a
 999 non-numeric prefix - `C-u M-x gnus', in short."
1000   :group 'gnus-server
1001   :type '(repeat string))
1002
1003 (defcustom gnus-nntp-server nil
1004   "*The name of the host running the NNTP server.
1005 This variable is semi-obsolete.  Use the `gnus-select-method'
1006 variable instead."
1007   :group 'gnus-server
1008   :type '(choice (const :tag "disable" nil)
1009                  string))
1010
1011 (defcustom gnus-secondary-select-methods nil
1012   "A list of secondary methods that will be used for reading news.
1013 This is a list where each element is a complete select method (see
1014 `gnus-select-method').
1015
1016 If, for instance, you want to read your mail with the nnml backend,
1017 you could set this variable:
1018
1019 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1020   :group 'gnus-server
1021   :type '(repeat gnus-select-method))
1022
1023 (defvar gnus-backup-default-subscribed-newsgroups
1024   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1025   "Default default new newsgroups the first time Gnus is run.
1026 Should be set in paths.el, and shouldn't be touched by the user.")
1027
1028 (defcustom gnus-local-domain nil
1029   "Local domain name without a host name.
1030 The DOMAINNAME environment variable is used instead if it is defined.
1031 If the `system-name' function returns the full Internet name, there is
1032 no need to set this variable."
1033   :group 'gnus-message
1034   :type '(choice (const :tag "default" nil)
1035                  string))
1036
1037 (defvar gnus-local-organization nil
1038   "String with a description of what organization (if any) the user belongs to.
1039 Obsolete variable; use `message-user-organization' instead.")
1040
1041 ;; Customization variables
1042
1043 (defcustom gnus-refer-article-method nil
1044   "Preferred method for fetching an article by Message-ID.
1045 If you are reading news from the local spool (with nnspool), fetching
1046 articles by Message-ID is painfully slow.  By setting this method to an
1047 nntp method, you might get acceptable results.
1048
1049 The value of this variable must be a valid select method as discussed
1050 in the documentation of `gnus-select-method'.
1051
1052 It can also be a list of select methods, as well as the special symbol
1053 `current', which means to use the current select method.  If it is a
1054 list, Gnus will try all the methods in the list until it finds a match."
1055   :group 'gnus-server
1056   :type '(choice (const :tag "default" nil)
1057                  (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1058                  gnus-select-method
1059                  (repeat :menu-tag "Try multiple"
1060                          :tag "Multiple"
1061                          :value (current (nnweb "refer" (nnweb-type dejanews)))
1062                          (choice :tag "Method"
1063                                  (const current)
1064                                  (const :tag "DejaNews"
1065                                         (nnweb "refer" (nnweb-type dejanews)))
1066                                  gnus-select-method))))
1067
1068 (defcustom gnus-group-faq-directory
1069   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1070     "/ftp@sunsite.auc.dk:/pub/usenet/"
1071     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1072     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1073     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1074     "/ftp@rtfm.mit.edu:/pub/usenet/"
1075     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1076     "/ftp@ftp.sunet.se:/pub/usenet/"
1077     "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1078     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1079     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1080   "*Directory where the group FAQs are stored.
1081 This will most commonly be on a remote machine, and the file will be
1082 fetched by ange-ftp.
1083
1084 This variable can also be a list of directories.  In that case, the
1085 first element in the list will be used by default.  The others can
1086 be used when being prompted for a site.
1087
1088 Note that Gnus uses an aol machine as the default directory.  If this
1089 feels fundamentally unclean, just think of it as a way to finally get
1090 something of value back from them.
1091
1092 If the default site is too slow, try one of these:
1093
1094    North America: mirrors.aol.com                /pub/rtfm/usenet
1095                   ftp.seas.gwu.edu               /pub/rtfm
1096                   rtfm.mit.edu                   /pub/usenet
1097    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1098                   src.doc.ic.ac.uk               /usenet/news-FAQS
1099                   ftp.sunet.se                   /pub/usenet
1100                   sunsite.auc.dk                 /pub/usenet
1101    Asia:          nctuccca.edu.tw                /USENET/FAQ
1102                   hwarang.postech.ac.kr          /pub/usenet
1103                   ftp.hk.super.net               /mirror/faqs"
1104   :group 'gnus-group-various
1105   :type '(choice directory
1106                  (repeat directory)))
1107
1108 (defcustom gnus-use-cross-reference t
1109   "*Non-nil means that cross referenced articles will be marked as read.
1110 If nil, ignore cross references.  If t, mark articles as read in
1111 subscribed newsgroups.  If neither t nor nil, mark as read in all
1112 newsgroups."
1113   :group 'gnus-server
1114   :type '(choice (const :tag "off" nil)
1115                  (const :tag "subscribed" t)
1116                  (sexp :format "all"
1117                        :value always)))
1118
1119 (defcustom gnus-process-mark ?#
1120   "*Process mark."
1121   :group 'gnus-group-visual
1122   :group 'gnus-summary-marks
1123   :type 'character)
1124
1125 (defcustom gnus-large-newsgroup 200
1126   "*The number of articles which indicates a large newsgroup.
1127 If the number of articles in a newsgroup is greater than this value,
1128 confirmation is required for selecting the newsgroup."
1129   :group 'gnus-group-select
1130   :type 'integer)
1131
1132 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1133   "*Non-nil means that the default name of a file to save articles in is the group name.
1134 If it's nil, the directory form of the group name is used instead.
1135
1136 If this variable is a list, and the list contains the element
1137 `not-score', long file names will not be used for score files; if it
1138 contains the element `not-save', long file names will not be used for
1139 saving; and if it contains the element `not-kill', long file names
1140 will not be used for kill files.
1141
1142 Note that the default for this variable varies according to what system
1143 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1144 to nil while on all other systems it defaults to t."
1145   :group 'gnus-start
1146   :type 'boolean)
1147
1148 (defcustom gnus-kill-files-directory gnus-directory
1149   "*Name of the directory where kill files will be stored (default \"~/News\")."
1150   :group 'gnus-score-files
1151   :group 'gnus-score-kill
1152   :type 'directory)
1153
1154 (defcustom gnus-save-score nil
1155   "*If non-nil, save group scoring info."
1156   :group 'gnus-score-various
1157   :group 'gnus-start
1158   :type 'boolean)
1159
1160 (defcustom gnus-use-undo t
1161   "*If non-nil, allow undoing in Gnus group mode buffers."
1162   :group 'gnus-meta
1163   :type 'boolean)
1164
1165 (defcustom gnus-use-adaptive-scoring nil
1166   "*If non-nil, use some adaptive scoring scheme.
1167 If a list, then the values `word' and `line' are meaningful.  The
1168 former will perform adaption on individual words in the subject
1169 header while `line' will perform adaption on several headers."
1170   :group 'gnus-meta
1171   :group 'gnus-score-adapt
1172   :type '(set (const word) (const line)))
1173
1174 (defcustom gnus-use-cache 'passive
1175   "*If nil, Gnus will ignore the article cache.
1176 If `passive', it will allow entering (and reading) articles
1177 explicitly entered into the cache.  If anything else, use the
1178 cache to the full extent of the law."
1179   :group 'gnus-meta
1180   :group 'gnus-cache
1181   :type '(choice (const :tag "off" nil)
1182                  (const :tag "passive" passive)
1183                  (const :tag "active" t)))
1184
1185 (defcustom gnus-use-trees nil
1186   "*If non-nil, display a thread tree buffer."
1187   :group 'gnus-meta
1188   :type 'boolean)
1189
1190 (defcustom gnus-use-grouplens nil
1191   "*If non-nil, use GroupLens ratings."
1192   :group 'gnus-meta
1193   :type 'boolean)
1194
1195 (defcustom gnus-keep-backlog nil
1196   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1197 If it is a number N, then Gnus will only keep the last N articles
1198 read.  If it is neither nil nor a number, Gnus will keep all read
1199 articles.  This is not a good idea."
1200   :group 'gnus-meta
1201   :type '(choice (const :tag "off" nil)
1202                  integer
1203                  (sexp :format "all"
1204                        :value t)))
1205
1206 (defcustom gnus-use-nocem nil
1207   "*If non-nil, Gnus will read NoCeM cancel messages."
1208   :group 'gnus-meta
1209   :type 'boolean)
1210
1211 (defcustom gnus-suppress-duplicates nil
1212   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1213   :group 'gnus-meta
1214   :type 'boolean)
1215
1216 (defcustom gnus-use-scoring t
1217   "*If non-nil, enable scoring."
1218   :group 'gnus-meta
1219   :type 'boolean)
1220
1221 (defcustom gnus-use-picons nil
1222   "*If non-nil, display picons in a frame of their own."
1223   :group 'gnus-meta
1224   :type 'boolean)
1225
1226 (defcustom gnus-summary-prepare-exit-hook
1227   '(gnus-summary-expire-articles)
1228   "*A hook called when preparing to exit from the summary buffer.
1229 It calls `gnus-summary-expire-articles' by default."
1230   :group 'gnus-summary-exit
1231   :type 'hook)
1232
1233 (defcustom gnus-novice-user t
1234   "*Non-nil means that you are a usenet novice.
1235 If non-nil, verbose messages may be displayed and confirmations may be
1236 required."
1237   :group 'gnus-meta
1238   :type 'boolean)
1239
1240 (defcustom gnus-expert-user nil
1241   "*Non-nil means that you will never be asked for confirmation about anything.
1242 That doesn't mean *anything* anything; particularly destructive
1243 commands will still require prompting."
1244   :group 'gnus-meta
1245   :type 'boolean)
1246
1247 (defcustom gnus-interactive-catchup t
1248   "*If non-nil, require your confirmation when catching up a group."
1249   :group 'gnus-group-select
1250   :type 'boolean)
1251
1252 (defcustom gnus-interactive-exit t
1253   "*If non-nil, require your confirmation when exiting Gnus."
1254   :group 'gnus-exit
1255   :type 'boolean)
1256
1257 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1258   "*Function for extracting address components from a From header.
1259 Two pre-defined function exist: `gnus-extract-address-components',
1260 which is the default, quite fast, and too simplistic solution, and
1261 `mail-extract-address-components', which works much better, but is
1262 slower."
1263   :group 'gnus-summary-format
1264   :type '(radio (function-item gnus-extract-address-components)
1265                 (function-item mail-extract-address-components)
1266                 (function-item std11-extract-address-components)
1267                 (function :tag "Other")))
1268
1269 (defcustom gnus-carpal nil
1270   "*If non-nil, display clickable icons."
1271   :group 'gnus-meta
1272   :type 'boolean)
1273
1274 (defcustom gnus-shell-command-separator ";"
1275   "String used to separate to shell commands."
1276   :group 'gnus-files
1277   :type 'string)
1278
1279 (defcustom gnus-valid-select-methods
1280   '(("nntp" post address prompt-address physical-address)
1281     ("nnspool" post address)
1282     ("nnvirtual" post-mail virtual prompt-address)
1283     ("nnmbox" mail respool address)
1284     ("nnml" mail respool address)
1285     ("nnmh" mail respool address)
1286     ("nndir" post-mail prompt-address physical-address)
1287     ("nneething" none address prompt-address physical-address)
1288     ("nndoc" none address prompt-address)
1289     ("nnbabyl" mail address respool)
1290     ("nnkiboze" post virtual)
1291     ("nnsoup" post-mail address)
1292     ("nndraft" post-mail)
1293     ("nnfolder" mail respool address)
1294     ("nngateway" post-mail address prompt-address physical-address)
1295     ("nnweb" none)
1296     ("nnslashdot" post)
1297     ("nnultimate" none)
1298     ("nnwarchive" none)
1299     ("nnlistserv" none)
1300     ("nnagent" post-mail)
1301     ("nnimap" post-mail address prompt-address physical-address))
1302   "*An alist of valid select methods.
1303 The first element of each list lists should be a string with the name
1304 of the select method.  The other elements may be the category of
1305 this method (i. e., `post', `mail', `none' or whatever) or other
1306 properties that this method has (like being respoolable).
1307 If you implement a new select method, all you should have to change is
1308 this variable.  I think."
1309   :group 'gnus-server
1310   :type '(repeat (group (string :tag "Name")
1311                         (radio-button-choice (const :format "%v " post)
1312                                              (const :format "%v " mail)
1313                                              (const :format "%v " none)
1314                                              (const post-mail))
1315                         (checklist :inline t
1316                                    (const :format "%v " address)
1317                                    (const :format "%v " prompt-address)
1318                                    (const :format "%v " physical-address)
1319                                    (const :format "%v " virtual)
1320                                    (const respool)))))
1321
1322 (defun gnus-redefine-select-method-widget ()
1323   "Recomputes the select-method widget based on the value of
1324 `gnus-valid-select-methods'."
1325   (define-widget 'gnus-select-method 'list
1326     "Widget for entering a select method."
1327     :value '(nntp "")
1328     :tag "Select Method"
1329     :args `((choice :tag "Method"
1330                     ,@(mapcar (lambda (entry)
1331                                 (list 'const :format "%v\n"
1332                                       (intern (car entry))))
1333                               gnus-valid-select-methods)
1334                     (symbol :tag "other"))
1335             (string :tag "Address")
1336             (repeat :tag "Options"
1337                     :inline t
1338                     (list :format "%v"
1339                           variable
1340                           (sexp :tag "Value"))))
1341     ))
1342
1343 (gnus-redefine-select-method-widget)
1344
1345 (defcustom gnus-updated-mode-lines '(group article summary tree)
1346   "List of buffers that should update their mode lines.
1347 The list may contain the symbols `group', `article', `tree' and
1348 `summary'.  If the corresponding symbol is present, Gnus will keep
1349 that mode line updated with information that may be pertinent.
1350 If this variable is nil, screen refresh may be quicker."
1351   :group 'gnus-various
1352   :type '(set (const group)
1353               (const article)
1354               (const summary)
1355               (const tree)))
1356
1357 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1358 (defcustom gnus-mode-non-string-length nil
1359   "*Max length of mode-line non-string contents.
1360 If this is nil, Gnus will take space as is needed, leaving the rest
1361 of the modeline intact.  Note that the default of nil is unlikely
1362 to be desirable; see the manual for further details."
1363   :group 'gnus-various
1364   :type '(choice (const nil)
1365                  integer))
1366
1367 (defcustom gnus-auto-expirable-newsgroups nil
1368   "*Groups in which to automatically mark read articles as expirable.
1369 If non-nil, this should be a regexp that should match all groups in
1370 which to perform auto-expiry.  This only makes sense for mail groups."
1371   :group 'nnmail-expire
1372   :type '(choice (const nil)
1373                  regexp))
1374
1375 (defcustom gnus-total-expirable-newsgroups nil
1376   "*Groups in which to perform expiry of all read articles.
1377 Use with extreme caution.  All groups that match this regexp will be
1378 expiring - which means that all read articles will be deleted after
1379 \(say) one week.         (This only goes for mail groups and the like, of
1380 course.)"
1381   :group 'nnmail-expire
1382   :type '(choice (const nil)
1383                  regexp))
1384
1385 (defcustom gnus-group-uncollapsed-levels 1
1386   "Number of group name elements to leave alone when making a short group name."
1387   :group 'gnus-group-visual
1388   :type 'integer)
1389
1390 (defcustom gnus-group-use-permanent-levels nil
1391   "*If non-nil, once you set a level, Gnus will use this level."
1392   :group 'gnus-group-levels
1393   :type 'boolean)
1394
1395 ;; Hooks.
1396
1397 (defcustom gnus-load-hook nil
1398   "A hook run while Gnus is loaded."
1399   :group 'gnus-start
1400   :type 'hook)
1401
1402 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1403   "A hook called to apply kill files to a group.
1404 This hook is intended to apply a kill file to the selected newsgroup.
1405 The function `gnus-apply-kill-file' is called by default.
1406
1407 Since a general kill file is too heavy to use only for a few
1408 newsgroups, I recommend you to use a lighter hook function.  For
1409 example, if you'd like to apply a kill file to articles which contains
1410 a string `rmgroup' in subject in newsgroup `control', you can use the
1411 following hook:
1412
1413  (setq gnus-apply-kill-hook
1414       (list
1415         (lambda ()
1416           (cond ((string-match \"control\" gnus-newsgroup-name)
1417                  (gnus-kill \"Subject\" \"rmgroup\")
1418                  (gnus-expunge \"X\"))))))"
1419   :group 'gnus-score-kill
1420   :options '(gnus-apply-kill-file)
1421   :type 'hook)
1422
1423 (defcustom gnus-group-change-level-function nil
1424   "Function run when a group level is changed.
1425 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1426   :group 'gnus-group-levels
1427   :type 'function)
1428
1429 ;;; Face thingies.
1430
1431 (defcustom gnus-visual
1432   '(summary-highlight group-highlight article-highlight
1433                       mouse-face
1434                       summary-menu group-menu article-menu
1435                       tree-highlight menu highlight
1436                       browse-menu server-menu
1437                       page-marker tree-menu binary-menu pick-menu
1438                       grouplens-menu)
1439   "*Enable visual features.
1440 If `visual' is disabled, there will be no menus and few faces.  Most of
1441 the visual customization options below will be ignored.  Gnus will use
1442 less space and be faster as a result.
1443
1444 This variable can also be a list of visual elements to switch on.  For
1445 instance, to switch off all visual things except menus, you can say:
1446
1447    (setq gnus-visual '(menu))
1448
1449 Valid elements include `summary-highlight', `group-highlight',
1450 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1451 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1452 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1453 and `grouplens-menu'."
1454   :group 'gnus-meta
1455   :group 'gnus-visual
1456   :type '(set (const summary-highlight)
1457               (const group-highlight)
1458               (const article-highlight)
1459               (const mouse-face)
1460               (const summary-menu)
1461               (const group-menu)
1462               (const article-menu)
1463               (const tree-highlight)
1464               (const menu)
1465               (const highlight)
1466               (const browse-menu)
1467               (const server-menu)
1468               (const page-marker)
1469               (const tree-menu)
1470               (const binary-menu)
1471               (const pick-menu)
1472               (const grouplens-menu)))
1473
1474 (defcustom gnus-mouse-face
1475   (condition-case ()
1476       (if (gnus-visual-p 'mouse-face 'highlight)
1477           (if (boundp 'gnus-mouse-face)
1478               (or gnus-mouse-face 'highlight)
1479             'highlight)
1480         'default)
1481     (error 'highlight))
1482   "*Face used for group or summary buffer mouse highlighting.
1483 The line beneath the mouse pointer will be highlighted with this
1484 face."
1485   :group 'gnus-visual
1486   :type 'face)
1487
1488 (defcustom gnus-article-save-directory gnus-directory
1489   "*Name of the directory articles will be saved in (default \"~/News\")."
1490   :group 'gnus-article-saving
1491   :type 'directory)
1492
1493 (defvar gnus-plugged t
1494   "Whether Gnus is plugged or not.")
1495
1496 (defcustom gnus-default-charset 'iso-8859-1
1497   "Default charset assumed to be used when viewing non-ASCII characters.
1498 This variable is overridden on a group-to-group basis by the
1499 gnus-group-charset-alist variable and is only used on groups not
1500 covered by that variable."
1501   :type 'symbol
1502   :group 'gnus-charset)
1503
1504 (defcustom gnus-default-posting-charset nil
1505   "Default charset assumed to be used when posting non-ASCII characters.
1506 This variable is overridden on a group-to-group basis by the
1507 gnus-group-posting-charset-alist variable and is only used on groups not
1508 covered by that variable.
1509 If nil, no default charset is assumed when posting."
1510   :type 'symbol
1511   :group 'gnus-charset)
1512
1513 \f
1514 ;;; Internal variables
1515
1516 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1517 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1518 (defvar gnus-original-article-buffer " *Original Article*")
1519 (defvar gnus-newsgroup-name nil)
1520 (defvar gnus-ephemeral-servers nil)
1521
1522 (defvar gnus-agent nil
1523   "Whether we want to use the Gnus agent or not.")
1524
1525 (defvar gnus-command-method nil
1526   "Dynamically bound variable that says what the current backend is.")
1527
1528 (defvar gnus-current-select-method nil
1529   "The current method for selecting a newsgroup.")
1530
1531 (defvar gnus-tree-buffer "*Tree*"
1532   "Buffer where Gnus thread trees are displayed.")
1533
1534 ;; Dummy variable.
1535 (defvar gnus-use-generic-from nil)
1536
1537 ;; Variable holding the user answers to all method prompts.
1538 (defvar gnus-method-history nil)
1539
1540 ;; Variable holding the user answers to all mail method prompts.
1541 (defvar gnus-mail-method-history nil)
1542
1543 ;; Variable holding the user answers to all group prompts.
1544 (defvar gnus-group-history nil)
1545
1546 (defvar gnus-server-alist nil
1547   "List of available servers.")
1548
1549 (defcustom gnus-cache-directory
1550   (nnheader-concat gnus-directory "cache/")
1551   "*The directory where cached articles will be stored."
1552   :group 'gnus-cache
1553   :type 'directory)
1554
1555 (defvar gnus-predefined-server-alist
1556   `(("cache"
1557      nnspool "cache"
1558      (nnspool-spool-directory ,gnus-cache-directory)
1559      (nnspool-nov-directory ,gnus-cache-directory)
1560      (nnspool-active-file
1561       ,(nnheader-concat gnus-cache-directory "active"))))
1562   "List of predefined (convenience) servers.")
1563
1564 (defvar gnus-topic-indentation "");; Obsolete variable.
1565
1566 (defconst gnus-article-mark-lists
1567   '((marked . tick) (replied . reply)
1568     (expirable . expire) (killed . killed)
1569     (bookmarks . bookmark) (dormant . dormant)
1570     (scored . score) (saved . save)
1571     (cached . cache) (downloadable . download)
1572     (unsendable . unsend)))
1573
1574 (defvar gnus-headers-retrieved-by nil)
1575 (defvar gnus-article-reply nil)
1576 (defvar gnus-override-method nil)
1577 (defvar gnus-article-check-size nil)
1578 (defvar gnus-opened-servers nil)
1579
1580 (defvar gnus-current-kill-article nil)
1581
1582 (defvar gnus-have-read-active-file nil)
1583
1584 (defconst gnus-maintainer
1585   "semi-gnus-ja@meadow.scphys.kyoto-u.ac.jp (T-gnus Bugfixing Girls + Boys)"
1586   "The mail address of the T-gnus maintainers.")
1587
1588 (defcustom gnus-info-filename nil
1589   "*Controls language of gnus Info.
1590 If nil and current-language-environment is Japanese, go to gnus-ja.
1591 Otherwise go to corresponding Info.
1592 This variable can be nil, gnus or gnus-ja."
1593   :group 'gnus-start
1594   :type '(choice (const nil)
1595                  (const :tag "English" gnus)
1596                  (const :tag "Japanese" gnus-ja)))
1597
1598 (defvar gnus-info-nodes
1599   '((gnus-group-mode "The Group Buffer")
1600     (gnus-summary-mode "The Summary Buffer")
1601     (gnus-article-mode "The Article Buffer")
1602     (gnus-server-mode "The Server Buffer")
1603     (gnus-browse-mode "Browse Foreign Server")
1604     (gnus-tree-mode "Tree Display"))
1605   "Alist of major modes and related Info nodes.")
1606
1607 (defvar gnus-group-buffer "*Group*")
1608 (defvar gnus-summary-buffer "*Summary*")
1609 (defvar gnus-article-buffer "*Article*")
1610 (defvar gnus-server-buffer "*Server*")
1611
1612 (defvar gnus-slave nil
1613   "Whether this Gnus is a slave or not.")
1614
1615 (defvar gnus-batch-mode nil
1616   "Whether this Gnus is running in batch mode or not.")
1617
1618 (defvar gnus-variable-list
1619   '(gnus-newsrc-options gnus-newsrc-options-n
1620                         gnus-newsrc-last-checked-date
1621                         gnus-newsrc-alist gnus-server-alist
1622                         gnus-killed-list gnus-zombie-list
1623                         gnus-topic-topology gnus-topic-alist)
1624   "Gnus variables saved in the quick startup file.")
1625
1626 (defvar gnus-product-variable-file-list
1627   (let ((version (product-version (product-find 'gnus-vers)))
1628         (codesys (static-if (boundp 'MULE) '*ctext* 'ctext)))
1629     `(("strict-cache" ((product-version ,version) (emacs-version))
1630        binary
1631        gnus-format-specs-compiled)
1632       ("cache" ((product-version ,version))
1633        ,codesys
1634        gnus-format-specs)))
1635   "Gnus variables are saved in the produce depend quick startup files.")
1636
1637 (defcustom gnus-compile-user-specs t
1638   "If non-nil, the user-defined format specs will be byte-compiled
1639 automatically.
1640 It has an effect on the values of `gnus-*-line-format-spec'."
1641   :group 'gnus
1642   :type 'boolean)
1643
1644 (defvar gnus-newsrc-alist nil
1645   "Assoc list of read articles.
1646 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1647
1648 (defvar gnus-newsrc-hashtb nil
1649   "Hashtable of gnus-newsrc-alist.")
1650
1651 (defvar gnus-killed-list nil
1652   "List of killed newsgroups.")
1653
1654 (defvar gnus-killed-hashtb nil
1655   "Hash table equivalent of gnus-killed-list.")
1656
1657 (defvar gnus-zombie-list nil
1658   "List of almost dead newsgroups.")
1659
1660 (defvar gnus-description-hashtb nil
1661   "Descriptions of newsgroups.")
1662
1663 (defvar gnus-list-of-killed-groups nil
1664   "List of newsgroups that have recently been killed by the user.")
1665
1666 (defvar gnus-active-hashtb nil
1667   "Hashtable of active articles.")
1668
1669 (defvar gnus-moderated-hashtb nil
1670   "Hashtable of moderated newsgroups.")
1671
1672 ;; Save window configuration.
1673 (defvar gnus-prev-winconf nil)
1674
1675 (defvar gnus-reffed-article-number nil)
1676
1677 ;;; Let the byte-compiler know that we know about this variable.
1678 (defvar rmail-default-rmail-file)
1679
1680 (defvar gnus-dead-summary nil)
1681
1682 (defvar gnus-article-display-hook nil
1683   "Controls how the article buffer will look.  This is an obsolete variable;
1684 use the article treating faculties instead.  Is is described in Info node
1685 `Customizing Articles'.")
1686
1687 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1688   "Regexp matching invalid groups.")
1689
1690 ;;; End of variables.
1691
1692 ;; Define some autoload functions Gnus might use.
1693 (eval-and-compile
1694
1695   ;; This little mapcar goes through the list below and marks the
1696   ;; symbols in question as autoloaded functions.
1697   (mapcar
1698    (lambda (package)
1699      (let ((interactive (nth 1 (memq ':interactive package))))
1700        (mapcar
1701         (lambda (function)
1702           (let (keymap)
1703             (when (consp function)
1704               (setq keymap (car (memq 'keymap function)))
1705               (setq function (car function)))
1706             (unless (fboundp function)
1707               (autoload function (car package) nil interactive keymap))))
1708         (if (eq (nth 1 package) ':interactive)
1709             (nthcdr 3 package)
1710           (cdr package)))))
1711    '(("info" :interactive t Info-goto-node)
1712      ("pp" pp pp-to-string pp-eval-expression)
1713      ("ps-print" ps-print-preprint)
1714      ("browse-url" :interactive t browse-url)
1715      ("message" :interactive t
1716       message-send-and-exit message-yank-original)
1717      ("babel" babel-as-string)
1718      ("nnmail" nnmail-split-fancy nnmail-article-group)
1719      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1720      ("rmailout" rmail-output rmail-output-to-rmail-file)
1721      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1722       rmail-show-message rmail-summary-exists
1723       rmail-select-summary rmail-update-summary)
1724      ("gnus-audio" :interactive t gnus-audio-play)
1725      ("gnus-xmas" gnus-xmas-splash)
1726      ("gnus-soup" :interactive t
1727       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1728       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1729      ("nnsoup" nnsoup-pack-replies)
1730      ("score-mode" :interactive t gnus-score-mode)
1731      ("gnus-mh" gnus-summary-save-article-folder
1732       gnus-Folder-save-name gnus-folder-save-name)
1733      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1734      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1735       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1736       gnus-demon-add-disconnection gnus-demon-add-handler
1737       gnus-demon-remove-handler)
1738      ("gnus-demon" :interactive t
1739       gnus-demon-init gnus-demon-cancel)
1740      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1741       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1742      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1743       gnus-nocem-unwanted-article-p)
1744      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1745       gnus-server-server-name)
1746      ("gnus-srvr" gnus-browse-foreign-server)
1747      ("gnus-cite" :interactive t
1748       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1749       gnus-article-hide-citation gnus-article-fill-cited-article
1750       gnus-article-hide-citation-in-followups)
1751      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1752       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1753       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1754      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1755       gnus-cache-possibly-remove-articles gnus-cache-request-article
1756       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1757       gnus-cache-enter-remove-article gnus-cached-article-p
1758       gnus-cache-open gnus-cache-close gnus-cache-update-article
1759       gnus-cache-articles-in-group)
1760      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1761       gnus-cache-remove-article gnus-summary-insert-cached-articles)
1762      ("gnus-score" :interactive t
1763       gnus-summary-increase-score gnus-summary-set-score
1764       gnus-summary-raise-thread gnus-summary-raise-same-subject
1765       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1766       gnus-summary-lower-thread gnus-summary-lower-same-subject
1767       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1768       gnus-summary-current-score gnus-score-delta-default
1769       gnus-score-flush-cache gnus-score-close
1770       gnus-possibly-score-headers gnus-score-followup-article
1771       gnus-score-followup-thread)
1772      ("gnus-score"
1773       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1774       gnus-current-score-file-nondirectory gnus-score-adaptive
1775       gnus-score-find-trace gnus-score-file-name)
1776      ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
1777       gnus-score-customize)
1778      ("gnus-topic" :interactive t gnus-topic-mode)
1779      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1780       gnus-subscribe-topics)
1781      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1782      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1783      ("gnus-uu" :interactive t
1784       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1785       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1786       gnus-uu-mark-by-regexp gnus-uu-mark-all
1787       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1788       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1789       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1790       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1791       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1792       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1793       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1794       gnus-uu-mark-over gnus-uu-post-news)
1795      ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1796       gnus-uu-unmark-thread)
1797      ("gnus-msg" (gnus-summary-send-map keymap)
1798       gnus-article-mail gnus-copy-article-buffer gnus-following-method)
1799      ("gnus-msg" :interactive t
1800       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1801       gnus-summary-followup gnus-summary-followup-with-original
1802       gnus-summary-cancel-article gnus-summary-supersede-article
1803       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1804       gnus-summary-mail-forward gnus-summary-mail-other-window
1805       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1806       gnus-summary-wide-reply gnus-summary-followup-to-mail
1807       gnus-summary-followup-to-mail-with-original gnus-bug
1808       gnus-summary-wide-reply-with-original
1809       gnus-summary-post-forward gnus-summary-wide-reply-with-original
1810       gnus-summary-post-forward)
1811      ("gnus-picon" :interactive t gnus-article-display-picons
1812       gnus-group-display-picons)
1813      ("gnus-picon" gnus-picons-buffer-name)
1814      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1815       gnus-grouplens-mode)
1816      ("smiley" :interactive t gnus-smiley-display)
1817      ("smiley" smiley-toggle-buffer)
1818      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1819      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1820       gnus-list-of-unread-articles gnus-list-of-read-articles
1821       gnus-offer-save-summaries gnus-make-thread-indent-array
1822       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1823       gnus-summary-skip-intangible gnus-summary-article-number
1824       gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
1825      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1826       gnus-group-list-groups gnus-group-first-unread-group
1827       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1828       gnus-group-setup-buffer gnus-group-get-new-news
1829       gnus-group-make-help-group gnus-group-update-group
1830       gnus-group-iterate gnus-group-group-name)
1831      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1832       gnus-backlog-remove-article)
1833      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1834       gnus-article-prepare gnus-article-set-window-start
1835       gnus-article-next-page gnus-article-prev-page
1836       gnus-request-article-this-buffer gnus-article-mode
1837       gnus-article-setup-buffer gnus-narrow-to-page
1838       gnus-article-delete-invisible-text gnus-treat-article)
1839      ("gnus-art" :interactive t
1840       gnus-article-hide-headers gnus-article-hide-boring-headers
1841       gnus-article-treat-overstrike
1842       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1843       gnus-article-display-x-face
1844       gnus-article-decode-HZ
1845       gnus-article-wash-html
1846       gnus-article-hide-pgp
1847       gnus-article-hide-pem gnus-article-hide-signature
1848       gnus-article-strip-leading-blank-lines gnus-article-date-local
1849       gnus-article-date-original gnus-article-date-lapsed
1850       gnus-article-show-all-headers gnus-article-show-all
1851       gnus-article-edit-mode gnus-article-edit-article
1852       gnus-article-edit-done article-decode-encoded-words
1853       gnus-start-date-timer gnus-stop-date-timer
1854       gnus-article-toggle-headers)
1855      ("gnus-int" gnus-request-type)
1856      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1857       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1858      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1859       gnus-dup-enter-articles)
1860      ("gnus-range" gnus-copy-sequence)
1861      ("gnus-eform" gnus-edit-form)
1862      ("gnus-move" :interactive t
1863       gnus-group-move-group-to-server gnus-change-server)
1864      ("gnus-logic" gnus-score-advanced)
1865      ("gnus-undo" gnus-undo-mode gnus-undo-register)
1866      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1867       gnus-async-prefetch-article gnus-async-prefetch-remove-group
1868       gnus-async-halt-prefetch)
1869      ("gnus-offline"
1870       gnus-offline-setup)
1871      ("gnus-offline" :interactive t
1872       gnus-offline-toggle-plugged
1873       gnus-offline-set-unplugged-state
1874       gnus-offline-toggle-auto-hangup
1875       gnus-offline-toggle-on/off-send-mail
1876       gnus-offline-toggle-articles-to-fetch
1877       gnus-offline-set-interval-time
1878       gnus-offline-agent-expire)
1879      ("miee" :interactive t gnspool-get-news
1880       mail-spool-send news-spool-post)
1881      ("international/mw32misc" define-process-argument-editing
1882       general-process-argument-editing-function)
1883      ("gnus-agent" gnus-open-agent gnus-agent-get-function
1884       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1885       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1886       gnus-summary-set-agent-mark gnus-agent-save-group-info)
1887      ("gnus-agent" :interactive t
1888       gnus-unplugged gnus-agentize gnus-agent-batch)
1889      ("gnus-vm" :interactive t gnus-summary-save-in-vm
1890       gnus-summary-save-article-vm)
1891      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1892      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1893      ("gnus-mlspl" :interactive t gnus-group-split-setup
1894       gnus-group-split-update))))
1895
1896 (eval-and-compile
1897   (unless (featurep 'xemacs)
1898     (autoload 'gnus-smiley-display "gnus-bitmap" nil t)
1899     (autoload 'smiley-toggle-buffer "gnus-bitmap")
1900     (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")))
1901
1902 ;;; gnus-sum.el thingies
1903
1904
1905 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1906   "*The format specification of the lines in the summary buffer.
1907
1908 It works along the same lines as a normal formatting string,
1909 with some simple extensions.
1910
1911 %N   Article number, left padded with spaces (string)
1912 %S   Subject (string)
1913 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
1914 %n   Name of the poster (string)
1915 %a   Extracted name of the poster (string)
1916 %A   Extracted address of the poster (string)
1917 %F   Contents of the From: header (string)
1918 %f   Contents of the From: or To: headers (string)
1919 %x   Contents of the Xref: header (string)
1920 %D   Date of the article (string)
1921 %d   Date of the article (string) in DD-MMM format
1922 %M   Message-id of the article (string)
1923 %r   References of the article (string)
1924 %c   Number of characters in the article (integer)
1925 %L   Number of lines in the article (integer)
1926 %I   Indentation based on thread level (a string of spaces)
1927 %T   A string with two possible values: 80 spaces if the article
1928      is on thread level two or larger and 0 spaces on level one
1929 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
1930 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1931 %[   Opening bracket (character, \"[\" or \"<\")
1932 %]   Closing bracket (character, \"]\" or \">\")
1933 %>   Spaces of length thread-level (string)
1934 %<   Spaces of length (- 20 thread-level) (string)
1935 %i   Article score (number)
1936 %z   Article zcore (character)
1937 %t   Number of articles under the current thread (number).
1938 %e   Whether the thread is empty or not (character).
1939 %l   GroupLens score (string).
1940 %V   Total thread score (number).
1941 %P   The line number (number).
1942 %O   Download mark (character).
1943 %u   User defined specifier.  The next character in the format string should
1944      be a letter.  Gnus will call the function gnus-user-format-function-X,
1945      where X is the letter following %u.  The function will be passed the
1946      current header as argument.  The function should return a string, which
1947      will be inserted into the summary just like information from any other
1948      summary specifier.
1949
1950 Text between %( and %) will be highlighted with `gnus-mouse-face'
1951 when the mouse point is placed inside the area.  There can only be one
1952 such area.
1953
1954 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1955 with care.  For reasons of efficiency, Gnus will compute what column
1956 these characters will end up in, and \"hard-code\" that.  This means that
1957 it is invalid to have these specs after a variable-length spec.  Well,
1958 you might not be arrested, but your summary buffer will look strange,
1959 which is bad enough.
1960
1961 The smart choice is to have these specs as for to the left as
1962 possible.
1963
1964 This restriction may disappear in later versions of Gnus."
1965   :type 'string
1966   :group 'gnus-summary-format)
1967
1968 ;;;
1969 ;;; Skeleton keymaps
1970 ;;;
1971
1972 (defun gnus-suppress-keymap (keymap)
1973   (suppress-keymap keymap)
1974   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1975     (while keys
1976       (define-key keymap (pop keys) 'undefined))))
1977
1978 (defvar gnus-article-mode-map
1979   (let ((keymap (make-sparse-keymap)))
1980     (gnus-suppress-keymap keymap)
1981     keymap))
1982 (defvar gnus-summary-mode-map
1983   (let ((keymap (make-keymap)))
1984     (gnus-suppress-keymap keymap)
1985     keymap))
1986 (defvar gnus-group-mode-map
1987   (let ((keymap (make-keymap)))
1988     (gnus-suppress-keymap keymap)
1989     keymap))
1990
1991 \f
1992
1993 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1994 ;; If you want the cursor to go somewhere else, set these two
1995 ;; functions in some startup hook to whatever you want.
1996 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1997 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1998
1999 ;;; Various macros and substs.
2000
2001 (defun gnus-header-from (header)
2002   (mail-header-from header))
2003
2004 (defmacro gnus-gethash (string hashtable)
2005   "Get hash value of STRING in HASHTABLE."
2006   `(symbol-value (intern-soft ,string ,hashtable)))
2007
2008 (defmacro gnus-sethash (string value hashtable)
2009   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
2010   `(set (intern ,string ,hashtable) ,value))
2011 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2012
2013 (defmacro gnus-group-unread (group)
2014   "Get the currently computed number of unread articles in GROUP."
2015   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2016
2017 (defmacro gnus-group-entry (group)
2018   "Get the newsrc entry for GROUP."
2019   `(gnus-gethash ,group gnus-newsrc-hashtb))
2020
2021 (defmacro gnus-active (group)
2022   "Get active info on GROUP."
2023   `(gnus-gethash ,group gnus-active-hashtb))
2024
2025 (defmacro gnus-set-active (group active)
2026   "Set GROUP's active info."
2027   `(gnus-sethash ,group ,active gnus-active-hashtb))
2028
2029 ;; Info access macros.
2030
2031 (defmacro gnus-info-group (info)
2032   `(nth 0 ,info))
2033 (defmacro gnus-info-rank (info)
2034   `(nth 1 ,info))
2035 (defmacro gnus-info-read (info)
2036   `(nth 2 ,info))
2037 (defmacro gnus-info-marks (info)
2038   `(nth 3 ,info))
2039 (defmacro gnus-info-method (info)
2040   `(nth 4 ,info))
2041 (defmacro gnus-info-params (info)
2042   `(nth 5 ,info))
2043
2044 (defmacro gnus-info-level (info)
2045   `(let ((rank (gnus-info-rank ,info)))
2046      (if (consp rank)
2047          (car rank)
2048        rank)))
2049 (defmacro gnus-info-score (info)
2050   `(let ((rank (gnus-info-rank ,info)))
2051      (or (and (consp rank) (cdr rank)) 0)))
2052
2053 (defmacro gnus-info-set-group (info group)
2054   `(setcar ,info ,group))
2055 (defmacro gnus-info-set-rank (info rank)
2056   `(setcar (nthcdr 1 ,info) ,rank))
2057 (defmacro gnus-info-set-read (info read)
2058   `(setcar (nthcdr 2 ,info) ,read))
2059 (defmacro gnus-info-set-marks (info marks &optional extend)
2060   (if extend
2061       `(gnus-info-set-entry ,info ,marks 3)
2062     `(setcar (nthcdr 3 ,info) ,marks)))
2063 (defmacro gnus-info-set-method (info method &optional extend)
2064   (if extend
2065       `(gnus-info-set-entry ,info ,method 4)
2066     `(setcar (nthcdr 4 ,info) ,method)))
2067 (defmacro gnus-info-set-params (info params &optional extend)
2068   (if extend
2069       `(gnus-info-set-entry ,info ,params 5)
2070     `(setcar (nthcdr 5 ,info) ,params)))
2071
2072 (defun gnus-info-set-entry (info entry number)
2073   ;; Extend the info until we have enough elements.
2074   (while (<= (length info) number)
2075     (nconc info (list nil)))
2076   ;; Set the entry.
2077   (setcar (nthcdr number info) entry))
2078
2079 (defmacro gnus-info-set-level (info level)
2080   `(let ((rank (cdr ,info)))
2081      (if (consp (car rank))
2082          (setcar (car rank) ,level)
2083        (setcar rank ,level))))
2084 (defmacro gnus-info-set-score (info score)
2085   `(let ((rank (cdr ,info)))
2086      (if (consp (car rank))
2087          (setcdr (car rank) ,score)
2088        (setcar rank (cons (car rank) ,score)))))
2089
2090 (defmacro gnus-get-info (group)
2091   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2092
2093 ;; Byte-compiler warning.
2094 (defvar gnus-visual)
2095 ;; Find out whether the gnus-visual TYPE is wanted.
2096 (defun gnus-visual-p (&optional type class)
2097   (and gnus-visual                      ; Has to be non-nil, at least.
2098        (if (not type)                   ; We don't care about type.
2099            gnus-visual
2100          (if (listp gnus-visual)        ; It's a list, so we check it.
2101              (or (memq type gnus-visual)
2102                  (memq class gnus-visual))
2103            t))))
2104
2105 ;;; Load the compatability functions.
2106
2107 (require 'gnus-ems)
2108
2109 \f
2110 ;;;
2111 ;;; Shutdown
2112 ;;;
2113
2114 (defvar gnus-shutdown-alist nil)
2115
2116 (defun gnus-add-shutdown (function &rest symbols)
2117   "Run FUNCTION whenever one of SYMBOLS is shut down."
2118   (push (cons function symbols) gnus-shutdown-alist))
2119
2120 (defun gnus-shutdown (symbol)
2121   "Shut down everything that waits for SYMBOL."
2122   (let ((alist gnus-shutdown-alist)
2123         entry)
2124     (while (setq entry (pop alist))
2125       (when (memq symbol (cdr entry))
2126         (funcall (car entry))))))
2127
2128 \f
2129 ;;;
2130 ;;; Gnus Utility Functions
2131 ;;;
2132
2133
2134 (defmacro gnus-string-or (&rest strings)
2135   "Return the first element of STRINGS that is a non-blank string.
2136 STRINGS will be evaluated in normal `or' order."
2137   `(gnus-string-or-1 ',strings))
2138
2139 (defun gnus-string-or-1 (strings)
2140   (let (string)
2141     (while strings
2142       (setq string (eval (pop strings)))
2143       (if (string-match "^[ \t]*$" string)
2144           (setq string nil)
2145         (setq strings nil)))
2146     string))
2147
2148 (defun gnus-info-find-node ()
2149   "Find Info documentation of Gnus."
2150   (interactive)
2151   ;; Enlarge info window if needed.
2152   (let (gnus-info-buffer)
2153     (Info-goto-node
2154      (format "(%s)%s"
2155              (or gnus-info-filename
2156                  (get-language-info current-language-environment 'gnus-info)
2157                  "gnus")
2158              (cadr (assq major-mode gnus-info-nodes))))
2159     (setq gnus-info-buffer (current-buffer))
2160     (gnus-configure-windows 'info)))
2161
2162 ;;;
2163 ;;; gnus-interactive
2164 ;;;
2165
2166 (defvar gnus-current-prefix-symbol nil
2167   "Current prefix symbol.")
2168
2169 (defvar gnus-current-prefix-symbols nil
2170   "List of current prefix symbols.")
2171
2172 (defun gnus-interactive (string &optional params)
2173   "Return a list that can be fed to `interactive'.
2174 See `interactive' for full documentation.
2175
2176 Adds the following specs:
2177
2178 y -- The current symbolic prefix.
2179 Y -- A list of the current symbolic prefix(es).
2180 A -- Article number.
2181 H -- Article header.
2182 g -- Group name."
2183   (let ((i 0)
2184         out c prompt)
2185     (while (< i (length string))
2186       (string-match ".\\([^\n]*\\)\n?" string i)
2187       (setq c (aref string i))
2188       (when (match-end 1)
2189         (setq prompt (match-string 1 string)))
2190       (setq i (match-end 0))
2191       ;; We basically emulate just about everything that
2192       ;; `interactive' does, but add the specs listed above.
2193       (push
2194        (cond
2195         ((= c ?a)
2196          (completing-read prompt obarray 'fboundp t))
2197         ((= c ?b)
2198          (read-buffer prompt (current-buffer) t))
2199         ((= c ?B)
2200          (read-buffer prompt (other-buffer (current-buffer))))
2201         ((= c ?c)
2202          (read-char))
2203         ((= c ?C)
2204          (completing-read prompt obarray 'commandp t))
2205         ((= c ?d)
2206          (point))
2207         ((= c ?D)
2208          (read-file-name prompt nil default-directory 'lambda))
2209         ((= c ?f)
2210          (read-file-name prompt nil nil 'lambda))
2211         ((= c ?F)
2212          (read-file-name prompt))
2213         ((= c ?k)
2214          (read-key-sequence prompt))
2215         ((= c ?K)
2216          (error "Not implemented spec"))
2217         ((= c ?e)
2218          (error "Not implemented spec"))
2219         ((= c ?m)
2220          (mark))
2221         ((= c ?N)
2222          (error "Not implemented spec"))
2223         ((= c ?n)
2224          (string-to-number (read-from-minibuffer prompt)))
2225         ((= c ?p)
2226          (prefix-numeric-value current-prefix-arg))
2227         ((= c ?P)
2228          current-prefix-arg)
2229         ((= c ?r)
2230          'gnus-prefix-nil)
2231         ((= c ?s)
2232          (read-string prompt))
2233         ((= c ?S)
2234          (intern (read-string prompt)))
2235         ((= c ?v)
2236          (read-variable prompt))
2237         ((= c ?x)
2238          (read-minibuffer prompt))
2239         ((= c ?x)
2240          (eval-minibuffer prompt))
2241         ;; And here the new specs come.
2242         ((= c ?y)
2243          gnus-current-prefix-symbol)
2244         ((= c ?Y)
2245          gnus-current-prefix-symbols)
2246         ((= c ?g)
2247          (gnus-group-group-name))
2248         ((= c ?A)
2249          (gnus-summary-skip-intangible)
2250          (or (get-text-property (point) 'gnus-number)
2251              (gnus-summary-last-subject)))
2252         ((= c ?H)
2253          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2254         (t
2255          (error "Non-implemented spec")))
2256        out)
2257       (cond
2258        ((= c ?r)
2259         (push (if (< (point) (mark) (point) (mark))) out)
2260         (push (if (> (point) (mark) (point) (mark))) out))))
2261     (setq out (delq 'gnus-prefix-nil out))
2262     (nreverse out)))
2263
2264 (defun gnus-symbolic-argument (&optional arg)
2265   "Read a symbolic argument and a command, and then execute command."
2266   (interactive "P")
2267   (let* ((in-command (this-command-keys))
2268          (command in-command)
2269          gnus-current-prefix-symbols
2270          gnus-current-prefix-symbol
2271          syms)
2272     (while (equal in-command command)
2273       (message "%s-" (key-description (this-command-keys)))
2274       (push (intern (char-to-string (read-char))) syms)
2275       (setq command (read-key-sequence nil t)))
2276     (setq gnus-current-prefix-symbols (nreverse syms)
2277           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2278     (call-interactively (key-binding command t))))
2279
2280 ;;; More various functions.
2281
2282 (defsubst gnus-check-backend-function (func group)
2283   "Check whether GROUP supports function FUNC.
2284 GROUP can either be a string (a group name) or a select method."
2285   (ignore-errors
2286     (let ((method (if (stringp group)
2287                       (car (gnus-find-method-for-group group))
2288                     group)))
2289       (unless (featurep method)
2290         (require method))
2291       (fboundp (intern (format "%s-%s" method func))))))
2292
2293 (defun gnus-group-read-only-p (&optional group)
2294   "Check whether GROUP supports editing or not.
2295 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
2296 that that variable is buffer-local to the summary buffers."
2297   (let ((group (or group gnus-newsgroup-name)))
2298     (not (gnus-check-backend-function 'request-replace-article group))))
2299
2300 (defun gnus-group-total-expirable-p (group)
2301   "Check whether GROUP is total-expirable or not."
2302   (let ((params (gnus-group-find-parameter group))
2303         val)
2304     (cond
2305      ((memq 'total-expire params)
2306       t)
2307      ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2308       (cdr val))
2309      (gnus-total-expirable-newsgroups   ; Check var.
2310       (string-match gnus-total-expirable-newsgroups group)))))
2311
2312 (defun gnus-group-auto-expirable-p (group)
2313   "Check whether GROUP is auto-expirable or not."
2314   (let ((params (gnus-group-find-parameter group))
2315         val)
2316     (cond
2317      ((memq 'auto-expire params)
2318       t)
2319      ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2320       (cdr val))
2321      (gnus-auto-expirable-newsgroups    ; Check var.
2322       (string-match gnus-auto-expirable-newsgroups group)))))
2323
2324 (defun gnus-virtual-group-p (group)
2325   "Say whether GROUP is virtual or not."
2326   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2327                         gnus-valid-select-methods)))
2328
2329 (defun gnus-news-group-p (group &optional article)
2330   "Return non-nil if GROUP (and ARTICLE) come from a news server."
2331   (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2332       (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2333            (if (or (null article)
2334                    (not (< article 0)))
2335                (eq (gnus-request-type group article) 'news)
2336              (if (not (vectorp article))
2337                  nil
2338                ;; It's a real article.
2339                (eq (gnus-request-type group (mail-header-id article))
2340                    'news))))))
2341
2342 ;; Returns a list of writable groups.
2343 (defun gnus-writable-groups ()
2344   (let ((alist gnus-newsrc-alist)
2345         groups group)
2346     (while (setq group (car (pop alist)))
2347       (unless (gnus-group-read-only-p group)
2348         (push group groups)))
2349     (nreverse groups)))
2350
2351 ;; Check whether to use long file names.
2352 (defun gnus-use-long-file-name (symbol)
2353   ;; The variable has to be set...
2354   (and gnus-use-long-file-name
2355        ;; If it isn't a list, then we return t.
2356        (or (not (listp gnus-use-long-file-name))
2357            ;; If it is a list, and the list contains `symbol', we
2358            ;; return nil.
2359            (not (memq symbol gnus-use-long-file-name)))))
2360
2361 ;; Generate a unique new group name.
2362 (defun gnus-generate-new-group-name (leaf)
2363   (let ((name leaf)
2364         (num 0))
2365     (while (gnus-gethash name gnus-newsrc-hashtb)
2366       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2367     name))
2368
2369 (defun gnus-ephemeral-group-p (group)
2370   "Say whether GROUP is ephemeral or not."
2371   (gnus-group-get-parameter group 'quit-config t))
2372
2373 (defun gnus-group-quit-config (group)
2374   "Return the quit-config of GROUP."
2375   (gnus-group-get-parameter group 'quit-config t))
2376
2377 (defun gnus-kill-ephemeral-group (group)
2378   "Remove ephemeral GROUP from relevant structures."
2379   (gnus-sethash group nil gnus-newsrc-hashtb))
2380
2381 (defun gnus-simplify-mode-line ()
2382   "Make mode lines a bit simpler."
2383   (setq mode-line-modified (cdr gnus-mode-line-modified))
2384   (when (listp mode-line-format)
2385     (make-local-variable 'mode-line-format)
2386     (setq mode-line-format (copy-sequence mode-line-format))
2387     (when (equal (nth 3 mode-line-format) "   ")
2388       (setcar (nthcdr 3 mode-line-format) " "))))
2389
2390 ;;; Servers and groups.
2391
2392 (defsubst gnus-server-add-address (method)
2393   (let ((method-name (symbol-name (car method))))
2394     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2395              (not (assq (intern (concat method-name "-address")) method))
2396              (memq 'physical-address (assq (car method)
2397                                            gnus-valid-select-methods)))
2398         (append method (list (list (intern (concat method-name "-address"))
2399                                    (nth 1 method))))
2400       method)))
2401
2402 (defsubst gnus-server-get-method (group method)
2403   ;; Input either a server name, and extended server name, or a
2404   ;; select method, and return a select method.
2405   (cond ((stringp method)
2406          (gnus-server-to-method method))
2407         ((equal method gnus-select-method)
2408          gnus-select-method)
2409         ((and (stringp (car method))
2410               group)
2411          (gnus-server-extend-method group method))
2412         ((and method
2413               (not group)
2414               (equal (cadr method) ""))
2415          method)
2416         (t
2417          (gnus-server-add-address method))))
2418
2419 (defun gnus-server-to-method (server)
2420   "Map virtual server names to select methods."
2421   (or
2422    ;; Is this a method, perhaps?
2423    (and server (listp server) server)
2424    ;; Perhaps this is the native server?
2425    (and (equal server "native") gnus-select-method)
2426    ;; It should be in the server alist.
2427    (cdr (assoc server gnus-server-alist))
2428    ;; It could be in the predefined server alist.
2429    (cdr (assoc server gnus-predefined-server-alist))
2430    ;; If not, we look through all the opened server
2431    ;; to see whether we can find it there.
2432    (let ((opened gnus-opened-servers))
2433      (while (and opened
2434                  (not (equal server (format "%s:%s" (caaar opened)
2435                                             (cadaar opened)))))
2436        (pop opened))
2437      (caar opened))
2438    ;; It could be a named method, search all servers
2439    (let ((servers gnus-secondary-select-methods))
2440      (while (and servers
2441                  (not (equal server (format "%s:%s" (caar servers)
2442                                             (cadar servers)))))
2443        (pop servers))
2444      (car servers))))
2445
2446 (defmacro gnus-method-equal (ss1 ss2)
2447   "Say whether two servers are equal."
2448   `(let ((s1 ,ss1)
2449          (s2 ,ss2))
2450      (or (equal s1 s2)
2451          (and (= (length s1) (length s2))
2452               (progn
2453                 (while (and s1 (member (car s1) s2))
2454                   (setq s1 (cdr s1)))
2455                 (null s1))))))
2456
2457 (defun gnus-methods-equal-p (m1 m2)
2458   (let ((m1 (or m1 gnus-select-method))
2459         (m2 (or m2 gnus-select-method)))
2460     (or (equal m1 m2)
2461         (and (eq (car m1) (car m2))
2462              (or (not (memq 'address (assoc (symbol-name (car m1))
2463                                             gnus-valid-select-methods)))
2464                  (equal (nth 1 m1) (nth 1 m2)))))))
2465
2466 (defun gnus-server-equal (m1 m2)
2467   "Say whether two methods are equal."
2468   (let ((m1 (cond ((null m1) gnus-select-method)
2469                   ((stringp m1) (gnus-server-to-method m1))
2470                   (t m1)))
2471         (m2 (cond ((null m2) gnus-select-method)
2472                   ((stringp m2) (gnus-server-to-method m2))
2473                   (t m2))))
2474     (gnus-method-equal m1 m2)))
2475
2476 (defun gnus-servers-using-backend (backend)
2477   "Return a list of known servers using BACKEND."
2478   (let ((opened gnus-opened-servers)
2479         out)
2480     (while opened
2481       (when (eq backend (caaar opened))
2482         (push (caar opened) out))
2483       (pop opened))
2484     out))
2485
2486 (defun gnus-archive-server-wanted-p ()
2487   "Say whether the user wants to use the archive server."
2488   (cond
2489    ((or (not gnus-message-archive-method)
2490         (not gnus-message-archive-group))
2491     nil)
2492    ((and gnus-message-archive-method gnus-message-archive-group)
2493     t)
2494    (t
2495     (let ((active (cadr (assq 'nnfolder-active-file
2496                               gnus-message-archive-method))))
2497       (and active
2498            (file-exists-p active))))))
2499
2500 (defun gnus-group-prefixed-name (group method)
2501   "Return the whole name from GROUP and METHOD."
2502   (and (stringp method) (setq method (gnus-server-to-method method)))
2503   (if (or (not method)
2504           (gnus-server-equal method "native"))
2505       group
2506     (concat (format "%s" (car method))
2507             (when (and
2508                    (or (assoc (format "%s" (car method))
2509                               (gnus-methods-using 'address))
2510                        (gnus-server-equal method gnus-message-archive-method))
2511                    (nth 1 method)
2512                    (not (string= (nth 1 method) "")))
2513               (concat "+" (nth 1 method)))
2514             ":" group)))
2515
2516 (defun gnus-group-real-prefix (group)
2517   "Return the prefix of the current group name."
2518   (if (string-match "^[^:]+:" group)
2519       (substring group 0 (match-end 0))
2520     ""))
2521
2522 (defun gnus-group-method (group)
2523   "Return the server or method used for selecting GROUP.
2524 You should probably use `gnus-find-method-for-group' instead."
2525   (let ((prefix (gnus-group-real-prefix group)))
2526     (if (equal prefix "")
2527         gnus-select-method
2528       (let ((servers gnus-opened-servers)
2529             (server "")
2530             backend possible found)
2531         (if (string-match "^[^\\+]+\\+" prefix)
2532             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2533                   server (substring prefix (match-end 0) (1- (length prefix))))
2534           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2535         (while servers
2536           (when (eq (caaar servers) backend)
2537             (setq possible (caar servers))
2538             (when (equal (cadaar servers) server)
2539               (setq found (caar servers))))
2540           (pop servers))
2541         (or (car (rassoc found gnus-server-alist))
2542             found
2543             (car (rassoc possible gnus-server-alist))
2544             possible
2545             (list backend server))))))
2546
2547 (defsubst gnus-native-method-p (method)
2548   "Return whether METHOD is the native select method."
2549   (gnus-method-equal method gnus-select-method))
2550
2551 (defsubst gnus-secondary-method-p (method)
2552   "Return whether METHOD is a secondary select method."
2553   (let ((methods gnus-secondary-select-methods)
2554         (gmethod (gnus-server-get-method nil method)))
2555     (while (and methods
2556                 (not (gnus-method-equal
2557                       (gnus-server-get-method nil (car methods))
2558                       gmethod)))
2559       (setq methods (cdr methods)))
2560     methods))
2561
2562 (defun gnus-method-simplify (method)
2563   "Return the shortest uniquely identifying string or method for METHOD."
2564   (cond ((stringp method)
2565          method)
2566         ((gnus-native-method-p method)
2567          nil)
2568         ((gnus-secondary-method-p method)
2569          (format "%s:%s" (nth 0 method) (nth 1 method)))
2570         (t
2571          method)))
2572
2573 (defun gnus-groups-from-server (server)
2574   "Return a list of all groups that are fetched from SERVER."
2575   (let ((alist (cdr gnus-newsrc-alist))
2576         info groups)
2577     (while (setq info (pop alist))
2578       (when (gnus-server-equal (gnus-info-method info) server)
2579         (push (gnus-info-group info) groups)))
2580     (sort groups 'string<)))
2581
2582 (defun gnus-group-foreign-p (group)
2583   "Say whether a group is foreign or not."
2584   (and (not (gnus-group-native-p group))
2585        (not (gnus-group-secondary-p group))))
2586
2587 (defun gnus-group-native-p (group)
2588   "Say whether the group is native or not."
2589   (not (string-match ":" group)))
2590
2591 (defun gnus-group-secondary-p (group)
2592   "Say whether the group is secondary or not."
2593   (gnus-secondary-method-p (gnus-find-method-for-group group)))
2594
2595 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2596   "Return the group parameters for GROUP.
2597 If SYMBOL, return the value of that symbol in the group parameters."
2598   (save-excursion
2599     (set-buffer gnus-group-buffer)
2600     (let ((parameters (funcall gnus-group-get-parameter-function group)))
2601       (if symbol
2602           (gnus-group-parameter-value parameters symbol allow-list)
2603         parameters))))
2604
2605 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2606   "Return the group parameters for GROUP.
2607 If SYMBOL, return the value of that symbol in the group parameters.
2608 Most functions should use `gnus-group-find-parameter', which
2609 also examines the topic parameters."
2610   (let ((params (gnus-info-params (gnus-get-info group))))
2611     (if symbol
2612         (gnus-group-parameter-value params symbol allow-list)
2613       params)))
2614
2615 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2616   "Return the value of SYMBOL in group PARAMS."
2617   ;; We only wish to return group parameters (dotted lists) and
2618   ;; not local variables, which may have the same names.
2619   ;; But first we handle single elements...
2620   (or (car (memq symbol params))
2621       ;; Handle alist.
2622       (let (elem)
2623         (catch 'found
2624           (while (setq elem (pop params))
2625             (when (and (consp elem)
2626                        (eq (car elem) symbol)
2627                        (or allow-list
2628                            (atom (cdr elem))))
2629               (throw 'found (cdr elem))))))))
2630
2631 (defun gnus-group-add-parameter (group param)
2632   "Add parameter PARAM to GROUP."
2633   (let ((info (gnus-get-info group)))
2634     (when info
2635       (gnus-group-remove-parameter group (if (consp param) (car param) param))
2636       ;; Cons the new param to the old one and update.
2637       (gnus-group-set-info (cons param (gnus-info-params info))
2638                            group 'params))))
2639
2640 (defun gnus-group-set-parameter (group name value)
2641   "Set parameter NAME to VALUE in GROUP."
2642   (let ((info (gnus-get-info group)))
2643     (when info
2644       (gnus-group-remove-parameter group name)
2645       (let ((old-params (gnus-info-params info))
2646             (new-params (list (cons name value))))
2647         (while old-params
2648           (when (or (not (listp (car old-params)))
2649                     (not (eq (caar old-params) name)))
2650             (setq new-params (append new-params (list (car old-params)))))
2651           (setq old-params (cdr old-params)))
2652         (gnus-group-set-info new-params group 'params)))))
2653
2654 (defun gnus-group-remove-parameter (group name)
2655   "Remove parameter NAME from GROUP."
2656   (let ((info (gnus-get-info group)))
2657     (when info
2658       (let ((params (gnus-info-params info)))
2659         (when params
2660           (setq params (delq name params))
2661           (while (assq name params)
2662             (gnus-pull name params))
2663           (gnus-info-set-params info params))))))
2664
2665 (defun gnus-group-add-score (group &optional score)
2666   "Add SCORE to the GROUP score.
2667 If SCORE is nil, add 1 to the score of GROUP."
2668   (let ((info (gnus-get-info group)))
2669     (when info
2670       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2671
2672 (defun gnus-short-group-name (group &optional levels)
2673   "Collapse GROUP name LEVELS.
2674 Select methods are stripped and any remote host name is stripped down to
2675 just the host name."
2676   (let* ((name "")
2677          (foreign "")
2678          (depth 0)
2679          (skip 1)
2680          (levels (or levels
2681                      gnus-group-uncollapsed-levels
2682                      (progn
2683                        (while (string-match "\\." group skip)
2684                          (setq skip (match-end 0)
2685                                depth (+ depth 1)))
2686                        depth))))
2687     ;; Separate foreign select method from group name and collapse.
2688     ;; If method contains a server, collapse to non-domain server name,
2689     ;; otherwise collapse to select method.
2690     (let* ((colon (string-match ":" group))
2691            (server (and colon (substring group 0 colon)))
2692            (plus (and server (string-match "+" server))))
2693       (when server
2694         (if plus
2695             (setq foreign (substring server (+ 1 plus)
2696                                      (string-match "\\." server))
2697                   group (substring group (+ 1 colon)))
2698           (setq foreign server
2699                 group (substring group (+ 1 colon))))
2700         (setq foreign (concat foreign ":")))
2701       ;; Collapse group name leaving LEVELS uncollapsed elements
2702       (let* ((glist (split-string group "\\."))
2703              (glen (length glist))
2704              res)
2705         (setq levels (- glen levels))
2706         (dolist (g glist)
2707           (push (if (>= (decf levels) 0)
2708                     (if (zerop (length g))
2709                         ""
2710                       (substring g 0 1))
2711                   g)
2712                 res))
2713         (concat foreign (mapconcat 'identity (nreverse res) "."))))))
2714
2715 (defun gnus-narrow-to-body ()
2716   "Narrow to the body of an article."
2717   (narrow-to-region
2718    (progn
2719      (goto-char (point-min))
2720      (or (search-forward "\n\n" nil t)
2721          (point-max)))
2722    (point-max)))
2723
2724 \f
2725 ;;;
2726 ;;; Kill file handling.
2727 ;;;
2728
2729 (defun gnus-apply-kill-file ()
2730   "Apply a kill file to the current newsgroup.
2731 Returns the number of articles marked as read."
2732   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2733           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2734       (gnus-apply-kill-file-internal)
2735     0))
2736
2737 (defun gnus-kill-save-kill-buffer ()
2738   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2739     (when (get-file-buffer file)
2740       (save-excursion
2741         (set-buffer (get-file-buffer file))
2742         (when (buffer-modified-p)
2743           (save-buffer))
2744         (kill-buffer (current-buffer))))))
2745
2746 (defcustom gnus-kill-file-name "KILL"
2747   "Suffix of the kill files."
2748   :group 'gnus-score-kill
2749   :group 'gnus-score-files
2750   :type 'string)
2751
2752 (defun gnus-newsgroup-kill-file (newsgroup)
2753   "Return the name of a kill file name for NEWSGROUP.
2754 If NEWSGROUP is nil, return the global kill file name instead."
2755   (cond
2756    ;; The global KILL file is placed at top of the directory.
2757    ((or (null newsgroup)
2758         (string-equal newsgroup ""))
2759     (expand-file-name gnus-kill-file-name
2760                       gnus-kill-files-directory))
2761    ;; Append ".KILL" to newsgroup name.
2762    ((gnus-use-long-file-name 'not-kill)
2763     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2764                               "." gnus-kill-file-name)
2765                       gnus-kill-files-directory))
2766    ;; Place "KILL" under the hierarchical directory.
2767    (t
2768     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2769                               "/" gnus-kill-file-name)
2770                       gnus-kill-files-directory))))
2771
2772 ;;; Server things.
2773
2774 (defun gnus-member-of-valid (symbol group)
2775   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2776   (memq symbol (assoc
2777                 (symbol-name (car (gnus-find-method-for-group group)))
2778                 gnus-valid-select-methods)))
2779
2780 (defun gnus-method-option-p (method option)
2781   "Return non-nil if select METHOD has OPTION as a parameter."
2782   (when (stringp method)
2783     (setq method (gnus-server-to-method method)))
2784   (memq option (assoc (format "%s" (car method))
2785                       gnus-valid-select-methods)))
2786
2787 (defun gnus-similar-server-opened (method)
2788   (let ((opened gnus-opened-servers))
2789     (while (and method opened)
2790       (when (and (equal (cadr method) (cadaar opened))
2791                  (equal (car method) (caaar opened))
2792                  (not (equal method (caar opened))))
2793         (setq method nil))
2794       (pop opened))
2795     (not method)))
2796
2797 (defun gnus-server-extend-method (group method)
2798   ;; This function "extends" a virtual server.  If the server is
2799   ;; "hello", and the select method is ("hello" (my-var "something"))
2800   ;; in the group "alt.alt", this will result in a new virtual server
2801   ;; called "hello+alt.alt".
2802   (if (or (not (inline (gnus-similar-server-opened method)))
2803           (not (cddr method)))
2804       method
2805     `(,(car method) ,(concat (cadr method) "+" group)
2806       (,(intern (format "%s-address" (car method))) ,(cadr method))
2807       ,@(cddr method))))
2808
2809 (defun gnus-server-status (method)
2810   "Return the status of METHOD."
2811   (nth 1 (assoc method gnus-opened-servers)))
2812
2813 (defun gnus-group-name-to-method (group)
2814   "Guess a select method based on GROUP."
2815   (if (string-match ":" group)
2816       (let ((server (substring group 0 (match-beginning 0))))
2817         (if (string-match "\\+" server)
2818             (list (intern (substring server 0 (match-beginning 0)))
2819                   (substring server (match-end 0)))
2820           (list (intern server) "")))
2821     gnus-select-method))
2822
2823 (defun gnus-find-method-for-group (group &optional info)
2824   "Find the select method that GROUP uses."
2825   (or gnus-override-method
2826       (and (not group)
2827            gnus-select-method)
2828       (and (not (gnus-group-entry group));; a new group
2829            (gnus-group-name-to-method group))
2830       (let ((info (or info (gnus-get-info group)))
2831             method)
2832         (if (or (not info)
2833                 (not (setq method (gnus-info-method info)))
2834                 (equal method "native"))
2835             gnus-select-method
2836           (setq method
2837                 (cond ((stringp method)
2838                        (inline (gnus-server-to-method method)))
2839                       ((stringp (cadr method))
2840                        (inline (gnus-server-extend-method group method)))
2841                       (t
2842                        method)))
2843           (cond ((equal (cadr method) "")
2844                  method)
2845                 ((null (cadr method))
2846                  (list (car method) ""))
2847                 (t
2848                  (gnus-server-add-address method)))))))
2849
2850 (defun gnus-methods-using (feature)
2851   "Find all methods that have FEATURE."
2852   (let ((valids gnus-valid-select-methods)
2853         outs)
2854     (while valids
2855       (when (memq feature (car valids))
2856         (push (car valids) outs))
2857       (setq valids (cdr valids)))
2858     outs))
2859
2860 (defun gnus-read-group (prompt &optional default)
2861   "Prompt the user for a group name.
2862 Disallow invalid group names."
2863   (let ((prefix "")
2864         group)
2865     (while (not group)
2866       (when (string-match
2867              gnus-invalid-group-regexp
2868              (setq group (read-string (concat prefix prompt)
2869                                       (cons (or default "") 0)
2870                                       'gnus-group-history)))
2871         (setq prefix (format "Invalid group name: \"%s\".  " group)
2872               group nil)))
2873     group))
2874
2875 (defun gnus-read-method (prompt)
2876   "Prompt the user for a method.
2877 Allow completion over sensible values."
2878   (let* ((servers
2879           (append gnus-valid-select-methods
2880                   (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2881                                                     (cadar i))))
2882                           gnus-opened-servers)
2883                   gnus-predefined-server-alist
2884                   gnus-server-alist))
2885          (method
2886           (completing-read
2887            prompt servers
2888            nil t nil 'gnus-method-history)))
2889     (cond
2890      ((equal method "")
2891       (setq method gnus-select-method))
2892      ((assoc method gnus-valid-select-methods)
2893       (let ((address (if (memq 'prompt-address
2894                                (assoc method gnus-valid-select-methods))
2895                          (read-string "Address: ")
2896                        "")))
2897         (or (let ((opened gnus-opened-servers))
2898               (while (and opened
2899                           (not (equal (format "%s:%s" method address)
2900                                       (format "%s:%s" (caaar opened)
2901                                               (cadaar opened)))))
2902                 (pop opened))
2903               (caar opened))
2904             (list (intern method) address))))
2905      ((assoc method servers)
2906       method)
2907      (t
2908       (list (intern method) "")))))
2909
2910 ;;; User-level commands.
2911
2912 ;;;###autoload
2913 (defun gnus-slave-no-server (&optional arg)
2914   "Read network news as a slave, without connecting to local server."
2915   (interactive "P")
2916   (gnus-no-server arg t))
2917
2918 ;;;###autoload
2919 (defun gnus-no-server (&optional arg slave)
2920   "Read network news.
2921 If ARG is a positive number, Gnus will use that as the
2922 startup level.  If ARG is nil, Gnus will be started at level 2.
2923 If ARG is non-nil and not a positive number, Gnus will
2924 prompt the user for the name of an NNTP server to use.
2925 As opposed to `gnus', this command will not connect to the local server."
2926   (interactive "P")
2927   (gnus-no-server-1 arg slave))
2928
2929 ;;;###autoload
2930 (defun gnus-slave (&optional arg)
2931   "Read news as a slave."
2932   (interactive "P")
2933   (gnus arg nil 'slave))
2934
2935 (defcustom gnus-frame-properties nil
2936   "The properties of the frame in which gnus is displayed. Under XEmacs,
2937 the variable `toolbar-news-frame-plist' will be refered instead."
2938   :type '(repeat (cons :format "%v"
2939                        (symbol :tag "Parameter")
2940                        (sexp :tag "Value")))
2941   :group 'gnus)
2942
2943 (defvar gnus-frame nil
2944   "The frame in which gnus is displayed. It is not used under XEmacs.")
2945
2946 ;;;###autoload
2947 (defun gnus-other-frame (&optional arg)
2948   "Pop up a frame to read news."
2949   (interactive "P")
2950   (static-if (featurep 'xemacs)
2951       (let ((toolbar-news-use-separate-frame t))
2952         (toolbar-gnus))
2953     (if (frame-live-p gnus-frame)
2954         (raise-frame gnus-frame)
2955       (setq gnus-frame (make-frame gnus-frame-properties))
2956       (if (and (gnus-buffer-live-p gnus-group-buffer)
2957                (save-current-buffer
2958                  (set-buffer gnus-group-buffer)
2959                  (eq 'gnus-group-mode major-mode)))
2960           (progn
2961             (select-frame gnus-frame)
2962             (switch-to-buffer gnus-group-buffer))
2963         (add-hook 'gnus-exit-gnus-hook
2964                   (lambda ()
2965                     (when (and (frame-live-p gnus-frame)
2966                                (cdr (frame-list)))
2967                       (delete-frame gnus-frame))
2968                     (setq gnus-frame nil)))
2969         (select-frame gnus-frame)
2970         (gnus arg)))))
2971
2972 ;;;###autoload
2973 (defun gnus (&optional arg dont-connect slave)
2974   "Read network news.
2975 If ARG is non-nil and a positive number, Gnus will use that as the
2976 startup level.  If ARG is non-nil and not a positive number, Gnus will
2977 prompt the user for the name of an NNTP server to use."
2978   (interactive "P")
2979   (gnus-1 arg dont-connect slave))
2980
2981 ;; Allow redefinition of Gnus functions.
2982
2983 (gnus-ems-redefine)
2984
2985 (product-provide (provide 'gnus) 'gnus-vers)
2986
2987 ;;; gnus.el ends here