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 (find-image '((:type xpm :file "gnus.xpm")
 756                                     (:type xbm :file "gnus.xbm")))))
 757            (when image
 758              (insert-image image " ")
 759              (goto-char (point-min))
 760              (while (not (eobp))
 761                (insert (make-string (/ (max (- (window-width) (or x 35)) 0) 2)
 762                                     ?\ ))
 763                (forward-line 1))
 764              (setq gnus-simple-splash nil)
 765              t))))
 766    (t
 767     (insert "
 768           _    ___ _             _
 769           _ ___ __ ___  __    _ ___
 770           __   _     ___    __  ___
 771               _           ___     _
 772              _  _ __             _
 773              ___   __            _
 774                    __           _
 775                     _      _   _
 776                    _      _    _
 777                       _  _    _
 778                   __  ___
 779                  _   _ _     _
 780                 _   _
 781               _    _
 782              _    _
 783             _
 784           __
 785
 786 "
 787             )
 788     (goto-char (point-min))
 789     (insert gnus-product-name " " gnus-version-number
 790             (if (zerop (string-to-number gnus-revision-number))
 791                 ""
 792               (concat " (r" gnus-revision-number ")"))
 793             " based on " gnus-original-product-name " v"
 794             gnus-original-version-number)
 795     (goto-char (point-min))
 796     (insert-char ?\ ; space
 797                  (max 0 (/ (- (window-width) (gnus-point-at-eol)) 2)))
 798     (forward-line 1)
 799     ;; And then hack it.
 800     (gnus-indent-rigidly (point) (point-max)
 801                          (/ (max (- (window-width) (or x 46)) 0) 2))
 802     (goto-char (point-min))
 803     (forward-line 1)
 804     (let* ((pheight (count-lines (point-min) (point-max)))
 805            (wheight (window-height))
 806            (rest (- wheight pheight)))
 807       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
 808     ;; Fontify some.
 809     (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
 810     (setq gnus-simple-splash t)))
 811   (goto-char (point-min))
 812   (setq mode-line-buffer-identification (concat " " gnus-version))
 813   (set-buffer-modified-p t))
 814
 815 (eval-when (load)
 816   (let ((command (format "%s" this-command)))
 817     (if (and (string-match "gnus" command)
 818              (not (string-match "gnus-other-frame" command)))
 819         (gnus-splash)
 820       (gnus-get-buffer-create gnus-group-buffer))))
 821
 822 ;;; Do the rest.
 823
 824 (require 'custom)
 825 (require 'gnus-util)
 826 (require 'nnheader)
 827
 828 (defcustom gnus-home-directory "~/"
 829   "Directory variable that specifies the \"home\" directory.
 830 All other Gnus path variables are initialized from this variable."
 831   :group 'gnus-files
 832   :type 'directory)
 833
 834 (defcustom gnus-directory (or (getenv "SAVEDIR")
 835                               (nnheader-concat gnus-home-directory "News/"))
 836   "*Directory variable from which all other Gnus file variables are derived.
 837
 838 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
 839 This means that other directory variables that are initialized from
 840 this variable won't be set properly if you set this variable in `.gnus.el'.
 841 Set this variable in `.emacs' instead."
 842   :group 'gnus-files
 843   :type 'directory)
 844
 845 (defcustom gnus-default-directory nil
 846   "*Default directory for all Gnus buffers."
 847   :group 'gnus-files
 848   :type '(choice (const :tag "current" nil)
 849                  directory))
 850
 851 ;; Site dependent variables.  These variables should be defined in
 852 ;; paths.el.
 853
 854 (defvar gnus-default-nntp-server nil
 855   "Specify a default NNTP server.
 856 This variable should be defined in paths.el, and should never be set
 857 by the user.
 858 If you want to change servers, you should use `gnus-select-method'.
 859 See the documentation to that variable.")
 860
 861 ;; Don't touch this variable.
 862 (defvar gnus-nntp-service "nntp"
 863   "NNTP service name (\"nntp\" or 119).
 864 This is an obsolete variable, which is scarcely used.  If you use an
 865 nntp server for your newsgroup and want to change the port number
 866 used to 899, you would say something along these lines:
 867
 868  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
 869
 870 (defcustom gnus-nntpserver-file "/etc/nntpserver"
 871   "A file with only the name of the nntp server in it."
 872   :group 'gnus-files
 873   :group 'gnus-server
 874   :type 'file)
 875
 876 ;; This function is used to check both the environment variable
 877 ;; NNTPSERVER and the /etc/nntpserver file to see whether one can find
 878 ;; an nntp server name default.
 879 (defun gnus-getenv-nntpserver ()
 880   (or (getenv "NNTPSERVER")
 881       (and (file-readable-p gnus-nntpserver-file)
 882            (save-excursion
 883              (set-buffer (gnus-get-buffer-create " *gnus nntp*"))
 884              (insert-file-contents gnus-nntpserver-file)
 885              (let ((name (buffer-string)))
 886                (prog1
 887                    (if (string-match "\\'[ \t\n]*$" name)
 888                        nil
 889                      name)
 890                  (kill-buffer (current-buffer))))))))
 891
 892 (defcustom gnus-select-method
 893   (condition-case nil
 894       (nconc
 895        (list 'nntp (or (condition-case nil
 896                            (gnus-getenv-nntpserver)
 897                          (error nil))
 898                        (when (and gnus-default-nntp-server
 899                                   (not (string= gnus-default-nntp-server "")))
 900                          gnus-default-nntp-server)
 901                        "news"))
 902        (if (or (null gnus-nntp-service)
 903                (equal gnus-nntp-service "nntp"))
 904            nil
 905          (list gnus-nntp-service)))
 906     (error nil))
 907   "*Default method for selecting a newsgroup.
 908 This variable should be a list, where the first element is how the
 909 news is to be fetched, the second is the address.
 910
 911 For instance, if you want to get your news via NNTP from
 912 \"flab.flab.edu\", you could say:
 913
 914 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
 915
 916 If you want to use your local spool, say:
 917
 918 \(setq gnus-select-method (list 'nnspool (system-name)))
 919
 920 If you use this variable, you must set `gnus-nntp-server' to nil.
 921
 922 There is a lot more to know about select methods and virtual servers -
 923 see the manual for details."
 924   :group 'gnus-server
 925   :type 'gnus-select-method)
 926
 927 (defcustom gnus-message-archive-method
 928   `(nnfolder
 929     "archive"
 930     (nnfolder-directory ,(nnheader-concat message-directory "archive"))
 931     (nnfolder-active-file
 932      ,(nnheader-concat message-directory "archive/active"))
 933     (nnfolder-get-new-mail nil)
 934     (nnfolder-inhibit-expiry t))
 935   "*Method used for archiving messages you've sent.
 936 This should be a mail method.
 937
 938 It's probably not very effective to change this variable once you've
 939 run Gnus once.  After doing that, you must edit this server from the
 940 server buffer."
 941   :group 'gnus-server
 942   :group 'gnus-message
 943   :type 'gnus-select-method)
 944
 945 (defcustom gnus-message-archive-group nil
 946   "*Name of the group in which to save the messages you've written.
 947 This can either be a string; a list of strings; or an alist
 948 of regexps/functions/forms to be evaluated to return a string (or a list
 949 of strings).  The functions are called with the name of the current
 950 group (or nil) as a parameter.
 951
 952 If you want to save your mail in one group and the news articles you
 953 write in another group, you could say something like:
 954
 955  \(setq gnus-message-archive-group
 956         '((if (message-news-p)
 957               \"misc-news\"
 958             \"misc-mail\")))
 959
 960 Normally the group names returned by this variable should be
 961 unprefixed -- which implicitly means \"store on the archive server\".
 962 However, you may wish to store the message on some other server.  In
 963 that case, just return a fully prefixed name of the group --
 964 \"nnml+private:mail.misc\", for instance."
 965   :group 'gnus-message
 966   :type '(choice (const :tag "none" nil)
 967                  function
 968                  sexp
 969                  string))
 970
 971 (defcustom gnus-secondary-servers nil
 972   "List of NNTP servers that the user can choose between interactively.
 973 To make Gnus query you for a server, you have to give `gnus' a
 974 non-numeric prefix - `C-u M-x gnus', in short."
 975   :group 'gnus-server
 976   :type '(repeat string))
 977
 978 (defcustom gnus-nntp-server nil
 979   "*The name of the host running the NNTP server.
 980 This variable is semi-obsolete.  Use the `gnus-select-method'
 981 variable instead."
 982   :group 'gnus-server
 983   :type '(choice (const :tag "disable" nil)
 984                  string))
 985
 986 (defcustom gnus-secondary-select-methods nil
 987   "A list of secondary methods that will be used for reading news.
 988 This is a list where each element is a complete select method (see
 989 `gnus-select-method').
 990
 991 If, for instance, you want to read your mail with the nnml backend,
 992 you could set this variable:
 993
 994 \(setq gnus-secondary-select-methods '((nnml \"\")))"
 995   :group 'gnus-server
 996   :type '(repeat gnus-select-method))
 997
 998 (defvar gnus-backup-default-subscribed-newsgroups
 999   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1000   "Default default new newsgroups the first time Gnus is run.
1001 Should be set in paths.el, and shouldn't be touched by the user.")
1002
1003 (defcustom gnus-local-domain nil
1004   "Local domain name without a host name.
1005 The DOMAINNAME environment variable is used instead if it is defined.
1006 If the `system-name' function returns the full Internet name, there is
1007 no need to set this variable."
1008   :group 'gnus-message
1009   :type '(choice (const :tag "default" nil)
1010                  string))
1011
1012 (defvar gnus-local-organization nil
1013   "String with a description of what organization (if any) the user belongs to.
1014 Obsolete variable; use `message-user-organization' instead.")
1015
1016 ;; Customization variables
1017
1018 (defcustom gnus-refer-article-method nil
1019   "Preferred method for fetching an article by Message-ID.
1020 If you are reading news from the local spool (with nnspool), fetching
1021 articles by Message-ID is painfully slow.  By setting this method to an
1022 nntp method, you might get acceptable results.
1023
1024 The value of this variable must be a valid select method as discussed
1025 in the documentation of `gnus-select-method'.
1026
1027 It can also be a list of select methods, as well as the special symbol
1028 `current', which means to use the current select method.  If it is a
1029 list, Gnus will try all the methods in the list until it finds a match."
1030   :group 'gnus-server
1031   :type '(choice (const :tag "default" nil)
1032                  (const :tag "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1033                  gnus-select-method
1034                  (repeat :menu-tag "Try multiple"
1035                          :tag "Multiple"
1036                          :value (current (nnweb "refer" (nnweb-type dejanews)))
1037                          (choice :tag "Method"
1038                                  (const current)
1039                                  (const :tag "DejaNews"
1040                                         (nnweb "refer" (nnweb-type dejanews)))
1041                                  gnus-select-method))))
1042
1043 (defcustom gnus-group-faq-directory
1044   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1045     "/ftp@sunsite.auc.dk:/pub/usenet/"
1046     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1047     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1048     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1049     "/ftp@rtfm.mit.edu:/pub/usenet/"
1050     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1051     "/ftp@ftp.sunet.se:/pub/usenet/"
1052     "/ftp@nctuccca.edu.tw:/USENET/FAQ/"
1053     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1054     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1055   "*Directory where the group FAQs are stored.
1056 This will most commonly be on a remote machine, and the file will be
1057 fetched by ange-ftp.
1058
1059 This variable can also be a list of directories.  In that case, the
1060 first element in the list will be used by default.  The others can
1061 be used when being prompted for a site.
1062
1063 Note that Gnus uses an aol machine as the default directory.  If this
1064 feels fundamentally unclean, just think of it as a way to finally get
1065 something of value back from them.
1066
1067 If the default site is too slow, try one of these:
1068
1069    North America: mirrors.aol.com                /pub/rtfm/usenet
1070                   ftp.seas.gwu.edu               /pub/rtfm
1071                   rtfm.mit.edu                   /pub/usenet
1072    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1073                   src.doc.ic.ac.uk               /usenet/news-FAQS
1074                   ftp.sunet.se                   /pub/usenet
1075                   sunsite.auc.dk                 /pub/usenet
1076    Asia:          nctuccca.edu.tw                /USENET/FAQ
1077                   hwarang.postech.ac.kr          /pub/usenet
1078                   ftp.hk.super.net               /mirror/faqs"
1079   :group 'gnus-group-various
1080   :type '(choice directory
1081                  (repeat directory)))
1082
1083 (defcustom gnus-use-cross-reference t
1084   "*Non-nil means that cross referenced articles will be marked as read.
1085 If nil, ignore cross references.  If t, mark articles as read in
1086 subscribed newsgroups.  If neither t nor nil, mark as read in all
1087 newsgroups."
1088   :group 'gnus-server
1089   :type '(choice (const :tag "off" nil)
1090                  (const :tag "subscribed" t)
1091                  (sexp :format "all"
1092                        :value always)))
1093
1094 (defcustom gnus-process-mark ?#
1095   "*Process mark."
1096   :group 'gnus-group-visual
1097   :group 'gnus-summary-marks
1098   :type 'character)
1099
1100 (defcustom gnus-asynchronous nil
1101   "*If non-nil, Gnus will supply backends with data needed for async article fetching."
1102   :group 'gnus-asynchronous
1103   :type 'boolean)
1104
1105 (defcustom gnus-large-newsgroup 200
1106   "*The number of articles which indicates a large newsgroup.
1107 If the number of articles in a newsgroup is greater than this value,
1108 confirmation is required for selecting the newsgroup."
1109   :group 'gnus-group-select
1110   :type 'integer)
1111
1112 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1113   "*Non-nil means that the default name of a file to save articles in is the group name.
1114 If it's nil, the directory form of the group name is used instead.
1115
1116 If this variable is a list, and the list contains the element
1117 `not-score', long file names will not be used for score files; if it
1118 contains the element `not-save', long file names will not be used for
1119 saving; and if it contains the element `not-kill', long file names
1120 will not be used for kill files.
1121
1122 Note that the default for this variable varies according to what system
1123 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1124 to nil while on all other systems it defaults to t."
1125   :group 'gnus-start
1126   :type 'boolean)
1127
1128 (defcustom gnus-kill-files-directory gnus-directory
1129   "*Name of the directory where kill files will be stored (default \"~/News\")."
1130   :group 'gnus-score-files
1131   :group 'gnus-score-kill
1132   :type 'directory)
1133
1134 (defcustom gnus-save-score nil
1135   "*If non-nil, save group scoring info."
1136   :group 'gnus-score-various
1137   :group 'gnus-start
1138   :type 'boolean)
1139
1140 (defcustom gnus-use-undo t
1141   "*If non-nil, allow undoing in Gnus group mode buffers."
1142   :group 'gnus-meta
1143   :type 'boolean)
1144
1145 (defcustom gnus-use-adaptive-scoring nil
1146   "*If non-nil, use some adaptive scoring scheme.
1147 If a list, then the values `word' and `line' are meaningful.  The
1148 former will perform adaption on individual words in the subject
1149 header while `line' will perform adaption on several headers."
1150   :group 'gnus-meta
1151   :group 'gnus-score-adapt
1152   :type '(set (const word) (const line)))
1153
1154 (defcustom gnus-use-cache 'passive
1155   "*If nil, Gnus will ignore the article cache.
1156 If `passive', it will allow entering (and reading) articles
1157 explicitly entered into the cache.  If anything else, use the
1158 cache to the full extent of the law."
1159   :group 'gnus-meta
1160   :group 'gnus-cache
1161   :type '(choice (const :tag "off" nil)
1162                  (const :tag "passive" passive)
1163                  (const :tag "active" t)))
1164
1165 (defcustom gnus-use-trees nil
1166   "*If non-nil, display a thread tree buffer."
1167   :group 'gnus-meta
1168   :type 'boolean)
1169
1170 (defcustom gnus-use-grouplens nil
1171   "*If non-nil, use GroupLens ratings."
1172   :group 'gnus-meta
1173   :type 'boolean)
1174
1175 (defcustom gnus-keep-backlog nil
1176   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1177 If it is a number N, then Gnus will only keep the last N articles
1178 read.  If it is neither nil nor a number, Gnus will keep all read
1179 articles.  This is not a good idea."
1180   :group 'gnus-meta
1181   :type '(choice (const :tag "off" nil)
1182                  integer
1183                  (sexp :format "all"
1184                        :value t)))
1185
1186 (defcustom gnus-use-nocem nil
1187   "*If non-nil, Gnus will read NoCeM cancel messages."
1188   :group 'gnus-meta
1189   :type 'boolean)
1190
1191 (defcustom gnus-suppress-duplicates nil
1192   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1193   :group 'gnus-meta
1194   :type 'boolean)
1195
1196 (defcustom gnus-use-scoring t
1197   "*If non-nil, enable scoring."
1198   :group 'gnus-meta
1199   :type 'boolean)
1200
1201 (defcustom gnus-use-picons nil
1202   "*If non-nil, display picons in a frame of their own."
1203   :group 'gnus-meta
1204   :type 'boolean)
1205
1206 (defcustom gnus-summary-prepare-exit-hook
1207   '(gnus-summary-expire-articles)
1208   "*A hook called when preparing to exit from the summary buffer.
1209 It calls `gnus-summary-expire-articles' by default."
1210   :group 'gnus-summary-exit
1211   :type 'hook)
1212
1213 (defcustom gnus-novice-user t
1214   "*Non-nil means that you are a usenet novice.
1215 If non-nil, verbose messages may be displayed and confirmations may be
1216 required."
1217   :group 'gnus-meta
1218   :type 'boolean)
1219
1220 (defcustom gnus-expert-user nil
1221   "*Non-nil means that you will never be asked for confirmation about anything.
1222 That doesn't mean *anything* anything; particularly destructive
1223 commands will still require prompting."
1224   :group 'gnus-meta
1225   :type 'boolean)
1226
1227 (defcustom gnus-interactive-catchup t
1228   "*If non-nil, require your confirmation when catching up a group."
1229   :group 'gnus-group-select
1230   :type 'boolean)
1231
1232 (defcustom gnus-interactive-exit t
1233   "*If non-nil, require your confirmation when exiting Gnus."
1234   :group 'gnus-exit
1235   :type 'boolean)
1236
1237 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1238   "*Function for extracting address components from a From header.
1239 Two pre-defined function exist: `gnus-extract-address-components',
1240 which is the default, quite fast, and too simplistic solution, and
1241 `mail-extract-address-components', which works much better, but is
1242 slower."
1243   :group 'gnus-summary-format
1244   :type '(radio (function-item gnus-extract-address-components)
1245                 (function-item mail-extract-address-components)
1246                 (function-item std11-extract-address-components)
1247                 (function :tag "Other")))
1248
1249 (defcustom gnus-carpal nil
1250   "*If non-nil, display clickable icons."
1251   :group 'gnus-meta
1252   :type 'boolean)
1253
1254 (defcustom gnus-shell-command-separator ";"
1255   "String used to separate to shell commands."
1256   :group 'gnus-files
1257   :type 'string)
1258
1259 (defcustom gnus-valid-select-methods
1260   '(("nntp" post address prompt-address physical-address)
1261     ("nnspool" post address)
1262     ("nnvirtual" post-mail virtual prompt-address)
1263     ("nnmbox" mail respool address)
1264     ("nnml" mail respool address)
1265     ("nnmh" mail respool address)
1266     ("nndir" post-mail prompt-address physical-address)
1267     ("nneething" none address prompt-address physical-address)
1268     ("nndoc" none address prompt-address)
1269     ("nnbabyl" mail address respool)
1270     ("nnkiboze" post virtual)
1271     ("nnsoup" post-mail address)
1272     ("nndraft" post-mail)
1273     ("nnfolder" mail respool address)
1274     ("nngateway" post-mail address prompt-address physical-address)
1275     ("nnweb" none)
1276     ("nnslashdot" post)
1277     ("nnultimate" none)
1278     ("nnwarchive" none)
1279     ("nnlistserv" none)
1280     ("nnagent" post-mail)
1281     ("nnimap" post-mail address prompt-address physical-address))
1282   "*An alist of valid select methods.
1283 The first element of each list lists should be a string with the name
1284 of the select method.  The other elements may be the category of
1285 this method (i. e., `post', `mail', `none' or whatever) or other
1286 properties that this method has (like being respoolable).
1287 If you implement a new select method, all you should have to change is
1288 this variable.  I think."
1289   :group 'gnus-server
1290   :type '(repeat (group (string :tag "Name")
1291                         (radio-button-choice (const :format "%v " post)
1292                                              (const :format "%v " mail)
1293                                              (const :format "%v " none)
1294                                              (const post-mail))
1295                         (checklist :inline t
1296                                    (const :format "%v " address)
1297                                    (const :format "%v " prompt-address)
1298                                    (const :format "%v " physical-address)
1299                                    (const :format "%v " virtual)
1300                                    (const respool)))))
1301
1302 (define-widget 'gnus-select-method 'list
1303   "Widget for entering a select method."
1304   :value '(nntp "")
1305   :tag "Select Method"
1306   :args `((choice :tag "Method"
1307                   ,@(mapcar (lambda (entry)
1308                               (list 'const :format "%v\n"
1309                                     (intern (car entry))))
1310                             gnus-valid-select-methods))
1311           (string :tag "Address")
1312           (repeat :tag "Options"
1313                   :inline t
1314                   (list :format "%v"
1315                         variable
1316                         (sexp :tag "Value")))))
1317
1318 (defcustom gnus-updated-mode-lines '(group article summary tree)
1319   "List of buffers that should update their mode lines.
1320 The list may contain the symbols `group', `article', `tree' and
1321 `summary'.  If the corresponding symbol is present, Gnus will keep
1322 that mode line updated with information that may be pertinent.
1323 If this variable is nil, screen refresh may be quicker."
1324   :group 'gnus-various
1325   :type '(set (const group)
1326               (const article)
1327               (const summary)
1328               (const tree)))
1329
1330 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1331 (defcustom gnus-mode-non-string-length nil
1332   "*Max length of mode-line non-string contents.
1333 If this is nil, Gnus will take space as is needed, leaving the rest
1334 of the modeline intact.  Note that the default of nil is unlikely
1335 to be desirable; see the manual for further details."
1336   :group 'gnus-various
1337   :type '(choice (const nil)
1338                  integer))
1339
1340 (defcustom gnus-auto-expirable-newsgroups nil
1341   "*Groups in which to automatically mark read articles as expirable.
1342 If non-nil, this should be a regexp that should match all groups in
1343 which to perform auto-expiry.  This only makes sense for mail groups."
1344   :group 'nnmail-expire
1345   :type '(choice (const nil)
1346                  regexp))
1347
1348 (defcustom gnus-total-expirable-newsgroups nil
1349   "*Groups in which to perform expiry of all read articles.
1350 Use with extreme caution.  All groups that match this regexp will be
1351 expiring - which means that all read articles will be deleted after
1352 \(say) one week.         (This only goes for mail groups and the like, of
1353 course.)"
1354   :group 'nnmail-expire
1355   :type '(choice (const nil)
1356                  regexp))
1357
1358 (defcustom gnus-group-uncollapsed-levels 1
1359   "Number of group name elements to leave alone when making a short group name."
1360   :group 'gnus-group-visual
1361   :type 'integer)
1362
1363 (defcustom gnus-group-use-permanent-levels nil
1364   "*If non-nil, once you set a level, Gnus will use this level."
1365   :group 'gnus-group-levels
1366   :type 'boolean)
1367
1368 ;; Hooks.
1369
1370 (defcustom gnus-load-hook nil
1371   "A hook run while Gnus is loaded."
1372   :group 'gnus-start
1373   :type 'hook)
1374
1375 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1376   "A hook called to apply kill files to a group.
1377 This hook is intended to apply a kill file to the selected newsgroup.
1378 The function `gnus-apply-kill-file' is called by default.
1379
1380 Since a general kill file is too heavy to use only for a few
1381 newsgroups, I recommend you to use a lighter hook function.  For
1382 example, if you'd like to apply a kill file to articles which contains
1383 a string `rmgroup' in subject in newsgroup `control', you can use the
1384 following hook:
1385
1386  (setq gnus-apply-kill-hook
1387       (list
1388         (lambda ()
1389           (cond ((string-match \"control\" gnus-newsgroup-name)
1390                  (gnus-kill \"Subject\" \"rmgroup\")
1391                  (gnus-expunge \"X\"))))))"
1392   :group 'gnus-score-kill
1393   :options '(gnus-apply-kill-file)
1394   :type 'hook)
1395
1396 (defcustom gnus-group-change-level-function nil
1397   "Function run when a group level is changed.
1398 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1399   :group 'gnus-group-levels
1400   :type 'function)
1401
1402 ;;; Face thingies.
1403
1404 (defcustom gnus-visual
1405   '(summary-highlight group-highlight article-highlight
1406                       mouse-face
1407                       summary-menu group-menu article-menu
1408                       tree-highlight menu highlight
1409                       browse-menu server-menu
1410                       page-marker tree-menu binary-menu pick-menu
1411                       grouplens-menu)
1412   "*Enable visual features.
1413 If `visual' is disabled, there will be no menus and few faces.  Most of
1414 the visual customization options below will be ignored.  Gnus will use
1415 less space and be faster as a result.
1416
1417 This variable can also be a list of visual elements to switch on.  For
1418 instance, to switch off all visual things except menus, you can say:
1419
1420    (setq gnus-visual '(menu))
1421
1422 Valid elements include `summary-highlight', `group-highlight',
1423 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1424 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1425 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1426 and `grouplens-menu'."
1427   :group 'gnus-meta
1428   :group 'gnus-visual
1429   :type '(set (const summary-highlight)
1430               (const group-highlight)
1431               (const article-highlight)
1432               (const mouse-face)
1433               (const summary-menu)
1434               (const group-menu)
1435               (const article-menu)
1436               (const tree-highlight)
1437               (const menu)
1438               (const highlight)
1439               (const browse-menu)
1440               (const server-menu)
1441               (const page-marker)
1442               (const tree-menu)
1443               (const binary-menu)
1444               (const pick-menu)
1445               (const grouplens-menu)))
1446
1447 (defcustom gnus-mouse-face
1448   (condition-case ()
1449       (if (gnus-visual-p 'mouse-face 'highlight)
1450           (if (boundp 'gnus-mouse-face)
1451               (or gnus-mouse-face 'highlight)
1452             'highlight)
1453         'default)
1454     (error 'highlight))
1455   "*Face used for group or summary buffer mouse highlighting.
1456 The line beneath the mouse pointer will be highlighted with this
1457 face."
1458   :group 'gnus-visual
1459   :type 'face)
1460
1461 (defcustom gnus-article-save-directory gnus-directory
1462   "*Name of the directory articles will be saved in (default \"~/News\")."
1463   :group 'gnus-article-saving
1464   :type 'directory)
1465
1466 (defvar gnus-plugged t
1467   "Whether Gnus is plugged or not.")
1468
1469 (defcustom gnus-default-charset 'iso-8859-1
1470   "Default charset assumed to be used when viewing non-ASCII characters.
1471 This variable is overridden on a group-to-group basis by the
1472 gnus-group-charset-alist variable and is only used on groups not
1473 covered by that variable."
1474   :type 'symbol
1475   :group 'gnus-charset)
1476
1477 (defcustom gnus-default-posting-charset nil
1478   "Default charset assumed to be used when posting non-ASCII characters.
1479 This variable is overridden on a group-to-group basis by the
1480 gnus-group-posting-charset-alist variable and is only used on groups not
1481 covered by that variable.
1482 If nil, no default charset is assumed when posting."
1483   :type 'symbol
1484   :group 'gnus-charset)
1485
1486 \f
1487 ;;; Internal variables
1488
1489 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1490 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1491 (defvar gnus-original-article-buffer " *Original Article*")
1492 (defvar gnus-newsgroup-name nil)
1493 (defvar gnus-ephemeral-servers nil)
1494
1495 (defvar gnus-agent nil
1496   "Whether we want to use the Gnus agent or not.")
1497
1498 (defvar gnus-command-method nil
1499   "Dynamically bound variable that says what the current backend is.")
1500
1501 (defvar gnus-current-select-method nil
1502   "The current method for selecting a newsgroup.")
1503
1504 (defvar gnus-tree-buffer "*Tree*"
1505   "Buffer where Gnus thread trees are displayed.")
1506
1507 ;; Dummy variable.
1508 (defvar gnus-use-generic-from nil)
1509
1510 ;; Variable holding the user answers to all method prompts.
1511 (defvar gnus-method-history nil)
1512
1513 ;; Variable holding the user answers to all mail method prompts.
1514 (defvar gnus-mail-method-history nil)
1515
1516 ;; Variable holding the user answers to all group prompts.
1517 (defvar gnus-group-history nil)
1518
1519 (defvar gnus-server-alist nil
1520   "List of available servers.")
1521
1522 (defcustom gnus-cache-directory
1523   (nnheader-concat gnus-directory "cache/")
1524   "*The directory where cached articles will be stored."
1525   :group 'gnus-cache
1526   :type 'directory)
1527
1528 (defvar gnus-predefined-server-alist
1529   `(("cache"
1530      nnspool "cache"
1531      (nnspool-spool-directory ,gnus-cache-directory)
1532      (nnspool-nov-directory ,gnus-cache-directory)
1533      (nnspool-active-file
1534       ,(nnheader-concat gnus-cache-directory "active"))))
1535   "List of predefined (convenience) servers.")
1536
1537 (defvar gnus-topic-indentation "");; Obsolete variable.
1538
1539 (defconst gnus-article-mark-lists
1540   '((marked . tick) (replied . reply)
1541     (expirable . expire) (killed . killed)
1542     (bookmarks . bookmark) (dormant . dormant)
1543     (scored . score) (saved . save)
1544     (cached . cache) (downloadable . download)
1545     (unsendable . unsend)))
1546
1547 (defvar gnus-headers-retrieved-by nil)
1548 (defvar gnus-article-reply nil)
1549 (defvar gnus-override-method nil)
1550 (defvar gnus-article-check-size nil)
1551 (defvar gnus-opened-servers nil)
1552
1553 (defvar gnus-current-kill-article nil)
1554
1555 (defvar gnus-have-read-active-file nil)
1556
1557 (defconst gnus-maintainer
1558   "semi-gnus-ja@meadow.scphys.kyoto-u.ac.jp (T-gnus Bugfixing Girls + Boys)"
1559   "The mail address of the T-gnus maintainers.")
1560
1561 (defcustom gnus-info-filename nil
1562   "*Controls language of gnus Info.
1563 If nil and current-language-environment is Japanese, go to gnus-ja.
1564 Otherwise go to corresponding Info.
1565 This variable can be nil, gnus or gnus-ja."
1566   :group 'gnus-start
1567   :type '(choice (const nil)
1568                  (const :tag "English" gnus)
1569                  (const :tag "Japanese" gnus-ja)))
1570
1571 (defvar gnus-info-nodes
1572   '((gnus-group-mode "The Group Buffer")
1573     (gnus-summary-mode "The Summary Buffer")
1574     (gnus-article-mode "The Article Buffer")
1575     (gnus-server-mode "The Server Buffer")
1576     (gnus-browse-mode "Browse Foreign Server")
1577     (gnus-tree-mode "Tree Display"))
1578   "Alist of major modes and related Info nodes.")
1579
1580 (defvar gnus-group-buffer "*Group*")
1581 (defvar gnus-summary-buffer "*Summary*")
1582 (defvar gnus-article-buffer "*Article*")
1583 (defvar gnus-server-buffer "*Server*")
1584
1585 (defvar gnus-slave nil
1586   "Whether this Gnus is a slave or not.")
1587
1588 (defvar gnus-batch-mode nil
1589   "Whether this Gnus is running in batch mode or not.")
1590
1591 (defvar gnus-variable-list
1592   '(gnus-newsrc-options gnus-newsrc-options-n
1593                         gnus-newsrc-last-checked-date
1594                         gnus-newsrc-alist gnus-server-alist
1595                         gnus-killed-list gnus-zombie-list
1596                         gnus-topic-topology gnus-topic-alist)
1597   "Gnus variables saved in the quick startup file.")
1598
1599 (defvar gnus-product-variable-file-list
1600   (let ((version (product-version (product-find 'gnus-vers)))
1601         (codesys (static-if (boundp 'MULE) '*ctext* 'ctext)))
1602     `(("strict-cache" ((product-version ,version) (emacs-version))
1603        binary
1604        gnus-format-specs-compiled)
1605       ("cache" ((product-version ,version))
1606        ,codesys
1607        gnus-format-specs)))
1608   "Gnus variables are saved in the produce depend quick startup files.")
1609
1610 (defcustom gnus-compile-user-specs t
1611   "If non-nil, the user-defined format specs will be byte-compiled
1612 automatically.
1613 It has an effect on the values of `gnus-*-line-format-spec'."
1614   :group 'gnus
1615   :type 'boolean)
1616
1617 (defvar gnus-newsrc-alist nil
1618   "Assoc list of read articles.
1619 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1620
1621 (defvar gnus-newsrc-hashtb nil
1622   "Hashtable of gnus-newsrc-alist.")
1623
1624 (defvar gnus-killed-list nil
1625   "List of killed newsgroups.")
1626
1627 (defvar gnus-killed-hashtb nil
1628   "Hash table equivalent of gnus-killed-list.")
1629
1630 (defvar gnus-zombie-list nil
1631   "List of almost dead newsgroups.")
1632
1633 (defvar gnus-description-hashtb nil
1634   "Descriptions of newsgroups.")
1635
1636 (defvar gnus-list-of-killed-groups nil
1637   "List of newsgroups that have recently been killed by the user.")
1638
1639 (defvar gnus-active-hashtb nil
1640   "Hashtable of active articles.")
1641
1642 (defvar gnus-moderated-hashtb nil
1643   "Hashtable of moderated newsgroups.")
1644
1645 ;; Save window configuration.
1646 (defvar gnus-prev-winconf nil)
1647
1648 (defvar gnus-reffed-article-number nil)
1649
1650 ;;; Let the byte-compiler know that we know about this variable.
1651 (defvar rmail-default-rmail-file)
1652
1653 (defvar gnus-dead-summary nil)
1654
1655 (defvar gnus-article-display-hook nil
1656   "Controls how the article buffer will look.  This is an obsolete variable;
1657 use the article treating faculties instead.  Is is described in Info node
1658 `Customizing Articles'.")
1659
1660 ;;; End of variables.
1661
1662 ;; Define some autoload functions Gnus might use.
1663 (eval-and-compile
1664
1665   ;; This little mapcar goes through the list below and marks the
1666   ;; symbols in question as autoloaded functions.
1667   (mapcar
1668    (lambda (package)
1669      (let ((interactive (nth 1 (memq ':interactive package))))
1670        (mapcar
1671         (lambda (function)
1672           (let (keymap)
1673             (when (consp function)
1674               (setq keymap (car (memq 'keymap function)))
1675               (setq function (car function)))
1676             (unless (fboundp function)
1677               (autoload function (car package) nil interactive keymap))))
1678         (if (eq (nth 1 package) ':interactive)
1679             (nthcdr 3 package)
1680           (cdr package)))))
1681    '(("info" :interactive t Info-goto-node)
1682      ("pp" pp pp-to-string pp-eval-expression)
1683      ("ps-print" ps-print-preprint)
1684      ("browse-url" :interactive t browse-url)
1685      ("message" :interactive t
1686       message-send-and-exit message-yank-original)
1687      ("babel" babel-as-string)
1688      ("nnmail" nnmail-split-fancy nnmail-article-group)
1689      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1690      ("rmailout" rmail-output rmail-output-to-rmail-file)
1691      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1692       rmail-show-message rmail-summary-exists
1693       rmail-select-summary rmail-update-summary)
1694      ("gnus-audio" :interactive t gnus-audio-play)
1695      ("gnus-xmas" gnus-xmas-splash)
1696      ("gnus-soup" :interactive t
1697       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1698       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1699      ("nnsoup" nnsoup-pack-replies)
1700      ("score-mode" :interactive t gnus-score-mode)
1701      ("gnus-mh" gnus-summary-save-article-folder
1702       gnus-Folder-save-name gnus-folder-save-name)
1703      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1704      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1705       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1706       gnus-demon-add-disconnection gnus-demon-add-handler
1707       gnus-demon-remove-handler)
1708      ("gnus-demon" :interactive t
1709       gnus-demon-init gnus-demon-cancel)
1710      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1711       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1712      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1713       gnus-nocem-unwanted-article-p)
1714      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1715       gnus-server-server-name)
1716      ("gnus-srvr" gnus-browse-foreign-server)
1717      ("gnus-cite" :interactive t
1718       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1719       gnus-article-hide-citation gnus-article-fill-cited-article
1720       gnus-article-hide-citation-in-followups)
1721      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1722       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1723       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1724      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1725       gnus-cache-possibly-remove-articles gnus-cache-request-article
1726       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1727       gnus-cache-enter-remove-article gnus-cached-article-p
1728       gnus-cache-open gnus-cache-close gnus-cache-update-article
1729       gnus-cache-articles-in-group)
1730      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1731       gnus-cache-remove-article gnus-summary-insert-cached-articles)
1732      ("gnus-score" :interactive t
1733       gnus-summary-increase-score gnus-summary-set-score
1734       gnus-summary-raise-thread gnus-summary-raise-same-subject
1735       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1736       gnus-summary-lower-thread gnus-summary-lower-same-subject
1737       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1738       gnus-summary-current-score gnus-score-delta-default
1739       gnus-score-flush-cache gnus-score-close
1740       gnus-possibly-score-headers gnus-score-followup-article
1741       gnus-score-followup-thread)
1742      ("gnus-score"
1743       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1744       gnus-current-score-file-nondirectory gnus-score-adaptive
1745       gnus-score-find-trace gnus-score-file-name)
1746      ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
1747       gnus-score-customize)
1748      ("gnus-topic" :interactive t gnus-topic-mode)
1749      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
1750       gnus-subscribe-topics)
1751      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1752      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1753      ("gnus-uu" :interactive t
1754       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1755       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1756       gnus-uu-mark-by-regexp gnus-uu-mark-all
1757       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1758       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1759       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1760       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1761       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1762       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1763       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1764       gnus-uu-mark-over gnus-uu-post-news)
1765      ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
1766       gnus-uu-unmark-thread)
1767      ("gnus-msg" (gnus-summary-send-map keymap)
1768       gnus-article-mail gnus-copy-article-buffer gnus-following-method)
1769      ("gnus-msg" :interactive t
1770       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1771       gnus-summary-followup gnus-summary-followup-with-original
1772       gnus-summary-cancel-article gnus-summary-supersede-article
1773       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1774       gnus-summary-mail-forward gnus-summary-mail-other-window
1775       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1776       gnus-summary-wide-reply gnus-summary-followup-to-mail
1777       gnus-summary-followup-to-mail-with-original gnus-bug
1778       gnus-summary-wide-reply-with-original
1779       gnus-summary-post-forward gnus-summary-wide-reply-with-original
1780       gnus-summary-post-forward)
1781      ("gnus-picon" :interactive t gnus-article-display-picons
1782       gnus-group-display-picons)
1783      ("gnus-picon" gnus-picons-buffer-name)
1784      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1785       gnus-grouplens-mode)
1786      ("smiley" :interactive t gnus-smiley-display)
1787      ("smiley" smiley-toggle-buffer)
1788      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1789      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1790       gnus-list-of-unread-articles gnus-list-of-read-articles
1791       gnus-offer-save-summaries gnus-make-thread-indent-array
1792       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1793       gnus-summary-skip-intangible gnus-summary-article-number
1794       gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
1795      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1796       gnus-group-list-groups gnus-group-first-unread-group
1797       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1798       gnus-group-setup-buffer gnus-group-get-new-news
1799       gnus-group-make-help-group gnus-group-update-group
1800       gnus-group-iterate gnus-group-group-name)
1801      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1802       gnus-backlog-remove-article)
1803      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1804       gnus-article-prepare gnus-article-set-window-start
1805       gnus-article-next-page gnus-article-prev-page
1806       gnus-request-article-this-buffer gnus-article-mode
1807       gnus-article-setup-buffer gnus-narrow-to-page
1808       gnus-article-delete-invisible-text gnus-treat-article)
1809      ("gnus-art" :interactive t
1810       gnus-article-hide-headers gnus-article-hide-boring-headers
1811       gnus-article-treat-overstrike
1812       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1813       gnus-article-display-x-face
1814       gnus-article-decode-HZ
1815       gnus-article-hide-pgp
1816       gnus-article-hide-pem gnus-article-hide-signature
1817       gnus-article-strip-leading-blank-lines gnus-article-date-local
1818       gnus-article-date-original gnus-article-date-lapsed
1819       gnus-article-show-all-headers gnus-article-show-all
1820       gnus-article-edit-mode gnus-article-edit-article
1821       gnus-article-edit-done article-decode-encoded-words
1822       gnus-start-date-timer gnus-stop-date-timer
1823       gnus-article-toggle-headers)
1824      ("gnus-int" gnus-request-type)
1825      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1826       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1827      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1828       gnus-dup-enter-articles)
1829      ("gnus-range" gnus-copy-sequence)
1830      ("gnus-eform" gnus-edit-form)
1831      ("gnus-move" :interactive t
1832       gnus-group-move-group-to-server gnus-change-server)
1833      ("gnus-logic" gnus-score-advanced)
1834      ("gnus-undo" gnus-undo-mode gnus-undo-register)
1835      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1836       gnus-async-prefetch-article gnus-async-prefetch-remove-group
1837       gnus-async-halt-prefetch)
1838      ("gnus-offline"
1839       gnus-offline-setup)
1840      ("gnus-offline" :interactive t
1841       gnus-offline-toggle-plugged
1842       gnus-offline-set-unplugged-state
1843       gnus-offline-toggle-auto-hangup
1844       gnus-offline-toggle-on/off-send-mail
1845       gnus-offline-toggle-articles-to-fetch
1846       gnus-offline-set-interval-time
1847       gnus-offline-agent-expire)
1848      ("miee" :interactive t gnspool-get-news
1849       mail-spool-send news-spool-post)
1850      ("international/mw32misc" define-process-argument-editing
1851       general-process-argument-editing-function)
1852      ("gnus-agent" gnus-open-agent gnus-agent-get-function
1853       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1854       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1855       gnus-summary-set-agent-mark gnus-agent-save-group-info)
1856      ("gnus-agent" :interactive t
1857       gnus-unplugged gnus-agentize gnus-agent-batch)
1858      ("gnus-vm" :interactive t gnus-summary-save-in-vm
1859       gnus-summary-save-article-vm)
1860      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts)
1861      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
1862      ("gnus-mlspl" :interactive t gnus-group-split-setup
1863       gnus-group-split-update))))
1864
1865 (eval-and-compile
1866   (unless (featurep 'xemacs)
1867     (autoload 'gnus-smiley-display "gnus-bitmap" nil t)
1868     (autoload 'smiley-toggle-buffer "gnus-bitmap")
1869     (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")))
1870
1871 ;;; gnus-sum.el thingies
1872
1873
1874 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1875   "*The format specification of the lines in the summary buffer.
1876
1877 It works along the same lines as a normal formatting string,
1878 with some simple extensions.
1879
1880 %N   Article number, left padded with spaces (string)
1881 %S   Subject (string)
1882 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
1883 %n   Name of the poster (string)
1884 %a   Extracted name of the poster (string)
1885 %A   Extracted address of the poster (string)
1886 %F   Contents of the From: header (string)
1887 %f   Contents of the From: or To: headers (string)
1888 %x   Contents of the Xref: header (string)
1889 %D   Date of the article (string)
1890 %d   Date of the article (string) in DD-MMM format
1891 %M   Message-id of the article (string)
1892 %r   References of the article (string)
1893 %c   Number of characters in the article (integer)
1894 %L   Number of lines in the article (integer)
1895 %I   Indentation based on thread level (a string of spaces)
1896 %T   A string with two possible values: 80 spaces if the article
1897      is on thread level two or larger and 0 spaces on level one
1898 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
1899 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1900 %[   Opening bracket (character, \"[\" or \"<\")
1901 %]   Closing bracket (character, \"]\" or \">\")
1902 %>   Spaces of length thread-level (string)
1903 %<   Spaces of length (- 20 thread-level) (string)
1904 %i   Article score (number)
1905 %z   Article zcore (character)
1906 %t   Number of articles under the current thread (number).
1907 %e   Whether the thread is empty or not (character).
1908 %l   GroupLens score (string).
1909 %V   Total thread score (number).
1910 %P   The line number (number).
1911 %O   Download mark (character).
1912 %u   User defined specifier.  The next character in the format string should
1913      be a letter.  Gnus will call the function gnus-user-format-function-X,
1914      where X is the letter following %u.  The function will be passed the
1915      current header as argument.  The function should return a string, which
1916      will be inserted into the summary just like information from any other
1917      summary specifier.
1918
1919 Text between %( and %) will be highlighted with `gnus-mouse-face'
1920 when the mouse point is placed inside the area.  There can only be one
1921 such area.
1922
1923 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1924 with care.  For reasons of efficiency, Gnus will compute what column
1925 these characters will end up in, and \"hard-code\" that.  This means that
1926 it is invalid to have these specs after a variable-length spec.  Well,
1927 you might not be arrested, but your summary buffer will look strange,
1928 which is bad enough.
1929
1930 The smart choice is to have these specs as for to the left as
1931 possible.
1932
1933 This restriction may disappear in later versions of Gnus."
1934   :type 'string
1935   :group 'gnus-summary-format)
1936
1937 ;;;
1938 ;;; Skeleton keymaps
1939 ;;;
1940
1941 (defun gnus-suppress-keymap (keymap)
1942   (suppress-keymap keymap)
1943   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1944     (while keys
1945       (define-key keymap (pop keys) 'undefined))))
1946
1947 (defvar gnus-article-mode-map
1948   (let ((keymap (make-sparse-keymap)))
1949     (gnus-suppress-keymap keymap)
1950     keymap))
1951 (defvar gnus-summary-mode-map
1952   (let ((keymap (make-keymap)))
1953     (gnus-suppress-keymap keymap)
1954     keymap))
1955 (defvar gnus-group-mode-map
1956   (let ((keymap (make-keymap)))
1957     (gnus-suppress-keymap keymap)
1958     keymap))
1959
1960 \f
1961
1962 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1963 ;; If you want the cursor to go somewhere else, set these two
1964 ;; functions in some startup hook to whatever you want.
1965 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1966 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1967
1968 ;;; Various macros and substs.
1969
1970 (defun gnus-header-from (header)
1971   (mail-header-from header))
1972
1973 (defmacro gnus-gethash (string hashtable)
1974   "Get hash value of STRING in HASHTABLE."
1975   `(symbol-value (intern-soft ,string ,hashtable)))
1976
1977 (defmacro gnus-sethash (string value hashtable)
1978   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
1979   `(set (intern ,string ,hashtable) ,value))
1980 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1981
1982 (defmacro gnus-group-unread (group)
1983   "Get the currently computed number of unread articles in GROUP."
1984   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1985
1986 (defmacro gnus-group-entry (group)
1987   "Get the newsrc entry for GROUP."
1988   `(gnus-gethash ,group gnus-newsrc-hashtb))
1989
1990 (defmacro gnus-active (group)
1991   "Get active info on GROUP."
1992   `(gnus-gethash ,group gnus-active-hashtb))
1993
1994 (defmacro gnus-set-active (group active)
1995   "Set GROUP's active info."
1996   `(gnus-sethash ,group ,active gnus-active-hashtb))
1997
1998 ;; Info access macros.
1999
2000 (defmacro gnus-info-group (info)
2001   `(nth 0 ,info))
2002 (defmacro gnus-info-rank (info)
2003   `(nth 1 ,info))
2004 (defmacro gnus-info-read (info)
2005   `(nth 2 ,info))
2006 (defmacro gnus-info-marks (info)
2007   `(nth 3 ,info))
2008 (defmacro gnus-info-method (info)
2009   `(nth 4 ,info))
2010 (defmacro gnus-info-params (info)
2011   `(nth 5 ,info))
2012
2013 (defmacro gnus-info-level (info)
2014   `(let ((rank (gnus-info-rank ,info)))
2015      (if (consp rank)
2016          (car rank)
2017        rank)))
2018 (defmacro gnus-info-score (info)
2019   `(let ((rank (gnus-info-rank ,info)))
2020      (or (and (consp rank) (cdr rank)) 0)))
2021
2022 (defmacro gnus-info-set-group (info group)
2023   `(setcar ,info ,group))
2024 (defmacro gnus-info-set-rank (info rank)
2025   `(setcar (nthcdr 1 ,info) ,rank))
2026 (defmacro gnus-info-set-read (info read)
2027   `(setcar (nthcdr 2 ,info) ,read))
2028 (defmacro gnus-info-set-marks (info marks &optional extend)
2029   (if extend
2030       `(gnus-info-set-entry ,info ,marks 3)
2031     `(setcar (nthcdr 3 ,info) ,marks)))
2032 (defmacro gnus-info-set-method (info method &optional extend)
2033   (if extend
2034       `(gnus-info-set-entry ,info ,method 4)
2035     `(setcar (nthcdr 4 ,info) ,method)))
2036 (defmacro gnus-info-set-params (info params &optional extend)
2037   (if extend
2038       `(gnus-info-set-entry ,info ,params 5)
2039     `(setcar (nthcdr 5 ,info) ,params)))
2040
2041 (defun gnus-info-set-entry (info entry number)
2042   ;; Extend the info until we have enough elements.
2043   (while (<= (length info) number)
2044     (nconc info (list nil)))
2045   ;; Set the entry.
2046   (setcar (nthcdr number info) entry))
2047
2048 (defmacro gnus-info-set-level (info level)
2049   `(let ((rank (cdr ,info)))
2050      (if (consp (car rank))
2051          (setcar (car rank) ,level)
2052        (setcar rank ,level))))
2053 (defmacro gnus-info-set-score (info score)
2054   `(let ((rank (cdr ,info)))
2055      (if (consp (car rank))
2056          (setcdr (car rank) ,score)
2057        (setcar rank (cons (car rank) ,score)))))
2058
2059 (defmacro gnus-get-info (group)
2060   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2061
2062 ;; Byte-compiler warning.
2063 (defvar gnus-visual)
2064 ;; Find out whether the gnus-visual TYPE is wanted.
2065 (defun gnus-visual-p (&optional type class)
2066   (and gnus-visual                      ; Has to be non-nil, at least.
2067        (if (not type)                   ; We don't care about type.
2068            gnus-visual
2069          (if (listp gnus-visual)        ; It's a list, so we check it.
2070              (or (memq type gnus-visual)
2071                  (memq class gnus-visual))
2072            t))))
2073
2074 ;;; Load the compatability functions.
2075
2076 (require 'gnus-ems)
2077
2078 \f
2079 ;;;
2080 ;;; Shutdown
2081 ;;;
2082
2083 (defvar gnus-shutdown-alist nil)
2084
2085 (defun gnus-add-shutdown (function &rest symbols)
2086   "Run FUNCTION whenever one of SYMBOLS is shut down."
2087   (push (cons function symbols) gnus-shutdown-alist))
2088
2089 (defun gnus-shutdown (symbol)
2090   "Shut down everything that waits for SYMBOL."
2091   (let ((alist gnus-shutdown-alist)
2092         entry)
2093     (while (setq entry (pop alist))
2094       (when (memq symbol (cdr entry))
2095         (funcall (car entry))))))
2096
2097 \f
2098 ;;;
2099 ;;; Gnus Utility Functions
2100 ;;;
2101
2102
2103 (defmacro gnus-string-or (&rest strings)
2104   "Return the first element of STRINGS that is a non-blank string.
2105 STRINGS will be evaluated in normal `or' order."
2106   `(gnus-string-or-1 ',strings))
2107
2108 (defun gnus-string-or-1 (strings)
2109   (let (string)
2110     (while strings
2111       (setq string (eval (pop strings)))
2112       (if (string-match "^[ \t]*$" string)
2113           (setq string nil)
2114         (setq strings nil)))
2115     string))
2116
2117 (defun gnus-info-find-node ()
2118   "Find Info documentation of Gnus."
2119   (interactive)
2120   ;; Enlarge info window if needed.
2121   (let (gnus-info-buffer)
2122     (Info-goto-node
2123      (format "(%s)%s"
2124              (or gnus-info-filename
2125                  (get-language-info current-language-environment 'gnus-info)
2126                  "gnus")
2127              (cadr (assq major-mode gnus-info-nodes))))
2128     (setq gnus-info-buffer (current-buffer))
2129     (gnus-configure-windows 'info)))
2130
2131 ;;;
2132 ;;; gnus-interactive
2133 ;;;
2134
2135 (defvar gnus-current-prefix-symbol nil
2136   "Current prefix symbol.")
2137
2138 (defvar gnus-current-prefix-symbols nil
2139   "List of current prefix symbols.")
2140
2141 (defun gnus-interactive (string &optional params)
2142   "Return a list that can be fed to `interactive'.
2143 See `interactive' for full documentation.
2144
2145 Adds the following specs:
2146
2147 y -- The current symbolic prefix.
2148 Y -- A list of the current symbolic prefix(es).
2149 A -- Article number.
2150 H -- Article header.
2151 g -- Group name."
2152   (let ((i 0)
2153         out c prompt)
2154     (while (< i (length string))
2155       (string-match ".\\([^\n]*\\)\n?" string i)
2156       (setq c (aref string i))
2157       (when (match-end 1)
2158         (setq prompt (match-string 1 string)))
2159       (setq i (match-end 0))
2160       ;; We basically emulate just about everything that
2161       ;; `interactive' does, but add the specs listed above.
2162       (push
2163        (cond
2164         ((= c ?a)
2165          (completing-read prompt obarray 'fboundp t))
2166         ((= c ?b)
2167          (read-buffer prompt (current-buffer) t))
2168         ((= c ?B)
2169          (read-buffer prompt (other-buffer (current-buffer))))
2170         ((= c ?c)
2171          (read-char))
2172         ((= c ?C)
2173          (completing-read prompt obarray 'commandp t))
2174         ((= c ?d)
2175          (point))
2176         ((= c ?D)
2177          (read-file-name prompt nil default-directory 'lambda))
2178         ((= c ?f)
2179          (read-file-name prompt nil nil 'lambda))
2180         ((= c ?F)
2181          (read-file-name prompt))
2182         ((= c ?k)
2183          (read-key-sequence prompt))
2184         ((= c ?K)
2185          (error "Not implemented spec"))
2186         ((= c ?e)
2187          (error "Not implemented spec"))
2188         ((= c ?m)
2189          (mark))
2190         ((= c ?N)
2191          (error "Not implemented spec"))
2192         ((= c ?n)
2193          (string-to-number (read-from-minibuffer prompt)))
2194         ((= c ?p)
2195          (prefix-numeric-value current-prefix-arg))
2196         ((= c ?P)
2197          current-prefix-arg)
2198         ((= c ?r)
2199          'gnus-prefix-nil)
2200         ((= c ?s)
2201          (read-string prompt))
2202         ((= c ?S)
2203          (intern (read-string prompt)))
2204         ((= c ?v)
2205          (read-variable prompt))
2206         ((= c ?x)
2207          (read-minibuffer prompt))
2208         ((= c ?x)
2209          (eval-minibuffer prompt))
2210         ;; And here the new specs come.
2211         ((= c ?y)
2212          gnus-current-prefix-symbol)
2213         ((= c ?Y)
2214          gnus-current-prefix-symbols)
2215         ((= c ?g)
2216          (gnus-group-group-name))
2217         ((= c ?A)
2218          (gnus-summary-skip-intangible)
2219          (or (get-text-property (point) 'gnus-number)
2220              (gnus-summary-last-subject)))
2221         ((= c ?H)
2222          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2223         (t
2224          (error "Non-implemented spec")))
2225        out)
2226       (cond
2227        ((= c ?r)
2228         (push (if (< (point) (mark) (point) (mark))) out)
2229         (push (if (> (point) (mark) (point) (mark))) out))))
2230     (setq out (delq 'gnus-prefix-nil out))
2231     (nreverse out)))
2232
2233 (defun gnus-symbolic-argument (&optional arg)
2234   "Read a symbolic argument and a command, and then execute command."
2235   (interactive "P")
2236   (let* ((in-command (this-command-keys))
2237          (command in-command)
2238          gnus-current-prefix-symbols
2239          gnus-current-prefix-symbol
2240          syms)
2241     (while (equal in-command command)
2242       (message "%s-" (key-description (this-command-keys)))
2243       (push (intern (char-to-string (read-char))) syms)
2244       (setq command (read-key-sequence nil t)))
2245     (setq gnus-current-prefix-symbols (nreverse syms)
2246           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2247     (call-interactively (key-binding command t))))
2248
2249 ;;; More various functions.
2250
2251 (defsubst gnus-check-backend-function (func group)
2252   "Check whether GROUP supports function FUNC.
2253 GROUP can either be a string (a group name) or a select method."
2254   (ignore-errors
2255     (let ((method (if (stringp group)
2256                       (car (gnus-find-method-for-group group))
2257                     group)))
2258       (unless (featurep method)
2259         (require method))
2260       (fboundp (intern (format "%s-%s" method func))))))
2261
2262 (defun gnus-group-read-only-p (&optional group)
2263   "Check whether GROUP supports editing or not.
2264 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
2265 that that variable is buffer-local to the summary buffers."
2266   (let ((group (or group gnus-newsgroup-name)))
2267     (not (gnus-check-backend-function 'request-replace-article group))))
2268
2269 (defun gnus-group-total-expirable-p (group)
2270   "Check whether GROUP is total-expirable or not."
2271   (let ((params (gnus-group-find-parameter group))
2272         val)
2273     (cond
2274      ((memq 'total-expire params)
2275       t)
2276      ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2277       (cdr val))
2278      (gnus-total-expirable-newsgroups   ; Check var.
2279       (string-match gnus-total-expirable-newsgroups group)))))
2280
2281 (defun gnus-group-auto-expirable-p (group)
2282   "Check whether GROUP is auto-expirable or not."
2283   (let ((params (gnus-group-find-parameter group))
2284         val)
2285     (cond
2286      ((memq 'auto-expire params)
2287       t)
2288      ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2289       (cdr val))
2290      (gnus-auto-expirable-newsgroups    ; Check var.
2291       (string-match gnus-auto-expirable-newsgroups group)))))
2292
2293 (defun gnus-virtual-group-p (group)
2294   "Say whether GROUP is virtual or not."
2295   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2296                         gnus-valid-select-methods)))
2297
2298 (defun gnus-news-group-p (group &optional article)
2299   "Return non-nil if GROUP (and ARTICLE) come from a news server."
2300   (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2301       (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2302            (eq (gnus-request-type group article) 'news))))
2303
2304 ;; Returns a list of writable groups.
2305 (defun gnus-writable-groups ()
2306   (let ((alist gnus-newsrc-alist)
2307         groups group)
2308     (while (setq group (car (pop alist)))
2309       (unless (gnus-group-read-only-p group)
2310         (push group groups)))
2311     (nreverse groups)))
2312
2313 ;; Check whether to use long file names.
2314 (defun gnus-use-long-file-name (symbol)
2315   ;; The variable has to be set...
2316   (and gnus-use-long-file-name
2317        ;; If it isn't a list, then we return t.
2318        (or (not (listp gnus-use-long-file-name))
2319            ;; If it is a list, and the list contains `symbol', we
2320            ;; return nil.
2321            (not (memq symbol gnus-use-long-file-name)))))
2322
2323 ;; Generate a unique new group name.
2324 (defun gnus-generate-new-group-name (leaf)
2325   (let ((name leaf)
2326         (num 0))
2327     (while (gnus-gethash name gnus-newsrc-hashtb)
2328       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2329     name))
2330
2331 (defun gnus-ephemeral-group-p (group)
2332   "Say whether GROUP is ephemeral or not."
2333   (gnus-group-get-parameter group 'quit-config t))
2334
2335 (defun gnus-group-quit-config (group)
2336   "Return the quit-config of GROUP."
2337   (gnus-group-get-parameter group 'quit-config t))
2338
2339 (defun gnus-kill-ephemeral-group (group)
2340   "Remove ephemeral GROUP from relevant structures."
2341   (gnus-sethash group nil gnus-newsrc-hashtb))
2342
2343 (defun gnus-simplify-mode-line ()
2344   "Make mode lines a bit simpler."
2345   (setq mode-line-modified (cdr gnus-mode-line-modified))
2346   (when (listp mode-line-format)
2347     (make-local-variable 'mode-line-format)
2348     (setq mode-line-format (copy-sequence mode-line-format))
2349     (when (equal (nth 3 mode-line-format) "   ")
2350       (setcar (nthcdr 3 mode-line-format) " "))))
2351
2352 ;;; Servers and groups.
2353
2354 (defsubst gnus-server-add-address (method)
2355   (let ((method-name (symbol-name (car method))))
2356     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2357              (not (assq (intern (concat method-name "-address")) method))
2358              (memq 'physical-address (assq (car method)
2359                                            gnus-valid-select-methods)))
2360         (append method (list (list (intern (concat method-name "-address"))
2361                                    (nth 1 method))))
2362       method)))
2363
2364 (defsubst gnus-server-get-method (group method)
2365   ;; Input either a server name, and extended server name, or a
2366   ;; select method, and return a select method.
2367   (cond ((stringp method)
2368          (gnus-server-to-method method))
2369         ((equal method gnus-select-method)
2370          gnus-select-method)
2371         ((and (stringp (car method))
2372               group)
2373          (gnus-server-extend-method group method))
2374         ((and method
2375               (not group)
2376               (equal (cadr method) ""))
2377          method)
2378         (t
2379          (gnus-server-add-address method))))
2380
2381 (defun gnus-server-to-method (server)
2382   "Map virtual server names to select methods."
2383   (or
2384    ;; Is this a method, perhaps?
2385    (and server (listp server) server)
2386    ;; Perhaps this is the native server?
2387    (and (equal server "native") gnus-select-method)
2388    ;; It should be in the server alist.
2389    (cdr (assoc server gnus-server-alist))
2390    ;; It could be in the predefined server alist.
2391    (cdr (assoc server gnus-predefined-server-alist))
2392    ;; If not, we look through all the opened server
2393    ;; to see whether we can find it there.
2394    (let ((opened gnus-opened-servers))
2395      (while (and opened
2396                  (not (equal server (format "%s:%s" (caaar opened)
2397                                             (cadaar opened)))))
2398        (pop opened))
2399      (caar opened))
2400    ;; It could be a named method, search all servers
2401    (let ((servers gnus-secondary-select-methods))
2402      (while (and servers
2403                  (not (equal server (format "%s:%s" (caar servers)
2404                                             (cadar servers)))))
2405        (pop servers))
2406      (car servers))))
2407
2408 (defmacro gnus-method-equal (ss1 ss2)
2409   "Say whether two servers are equal."
2410   `(let ((s1 ,ss1)
2411          (s2 ,ss2))
2412      (or (equal s1 s2)
2413          (and (= (length s1) (length s2))
2414               (progn
2415                 (while (and s1 (member (car s1) s2))
2416                   (setq s1 (cdr s1)))
2417                 (null s1))))))
2418
2419 (defun gnus-methods-equal-p (m1 m2)
2420   (let ((m1 (or m1 gnus-select-method))
2421         (m2 (or m2 gnus-select-method)))
2422     (or (equal m1 m2)
2423         (and (eq (car m1) (car m2))
2424              (or (not (memq 'address (assoc (symbol-name (car m1))
2425                                             gnus-valid-select-methods)))
2426                  (equal (nth 1 m1) (nth 1 m2)))))))
2427
2428 (defun gnus-server-equal (m1 m2)
2429   "Say whether two methods are equal."
2430   (let ((m1 (cond ((null m1) gnus-select-method)
2431                   ((stringp m1) (gnus-server-to-method m1))
2432                   (t m1)))
2433         (m2 (cond ((null m2) gnus-select-method)
2434                   ((stringp m2) (gnus-server-to-method m2))
2435                   (t m2))))
2436     (gnus-method-equal m1 m2)))
2437
2438 (defun gnus-servers-using-backend (backend)
2439   "Return a list of known servers using BACKEND."
2440   (let ((opened gnus-opened-servers)
2441         out)
2442     (while opened
2443       (when (eq backend (caaar opened))
2444         (push (caar opened) out))
2445       (pop opened))
2446     out))
2447
2448 (defun gnus-archive-server-wanted-p ()
2449   "Say whether the user wants to use the archive server."
2450   (cond
2451    ((or (not gnus-message-archive-method)
2452         (not gnus-message-archive-group))
2453     nil)
2454    ((and gnus-message-archive-method gnus-message-archive-group)
2455     t)
2456    (t
2457     (let ((active (cadr (assq 'nnfolder-active-file
2458                               gnus-message-archive-method))))
2459       (and active
2460            (file-exists-p active))))))
2461
2462 (defun gnus-group-prefixed-name (group method)
2463   "Return the whole name from GROUP and METHOD."
2464   (and (stringp method) (setq method (gnus-server-to-method method)))
2465   (if (or (not method)
2466           (gnus-server-equal method "native"))
2467       group
2468     (concat (format "%s" (car method))
2469             (when (and
2470                    (or (assoc (format "%s" (car method))
2471                               (gnus-methods-using 'address))
2472                        (gnus-server-equal method gnus-message-archive-method))
2473                    (nth 1 method)
2474                    (not (string= (nth 1 method) "")))
2475               (concat "+" (nth 1 method)))
2476             ":" group)))
2477
2478 (defun gnus-group-real-prefix (group)
2479   "Return the prefix of the current group name."
2480   (if (string-match "^[^:]+:" group)
2481       (substring group 0 (match-end 0))
2482     ""))
2483
2484 (defun gnus-group-method (group)
2485   "Return the server or method used for selecting GROUP.
2486 You should probably use `gnus-find-method-for-group' instead."
2487   (let ((prefix (gnus-group-real-prefix group)))
2488     (if (equal prefix "")
2489         gnus-select-method
2490       (let ((servers gnus-opened-servers)
2491             (server "")
2492             backend possible found)
2493         (if (string-match "^[^\\+]+\\+" prefix)
2494             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2495                   server (substring prefix (match-end 0) (1- (length prefix))))
2496           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2497         (while servers
2498           (when (eq (caaar servers) backend)
2499             (setq possible (caar servers))
2500             (when (equal (cadaar servers) server)
2501               (setq found (caar servers))))
2502           (pop servers))
2503         (or (car (rassoc found gnus-server-alist))
2504             found
2505             (car (rassoc possible gnus-server-alist))
2506             possible
2507             (list backend server))))))
2508
2509 (defsubst gnus-native-method-p (method)
2510   "Return whether METHOD is the native select method."
2511   (gnus-method-equal method gnus-select-method))
2512
2513 (defsubst gnus-secondary-method-p (method)
2514   "Return whether METHOD is a secondary select method."
2515   (let ((methods gnus-secondary-select-methods)
2516         (gmethod (gnus-server-get-method nil method)))
2517     (while (and methods
2518                 (not (gnus-method-equal
2519                       (gnus-server-get-method nil (car methods))
2520                       gmethod)))
2521       (setq methods (cdr methods)))
2522     methods))
2523
2524 (defun gnus-method-simplify (method)
2525   "Return the shortest uniquely identifying string or method for METHOD."
2526   (cond ((stringp method)
2527          method)
2528         ((gnus-native-method-p method)
2529          nil)
2530         ((gnus-secondary-method-p method)
2531          (format "%s:%s" (nth 0 method) (nth 1 method)))
2532         (t
2533          method)))
2534
2535 (defun gnus-groups-from-server (server)
2536   "Return a list of all groups that are fetched from SERVER."
2537   (let ((alist (cdr gnus-newsrc-alist))
2538         info groups)
2539     (while (setq info (pop alist))
2540       (when (gnus-server-equal (gnus-info-method info) server)
2541         (push (gnus-info-group info) groups)))
2542     (sort groups 'string<)))
2543
2544 (defun gnus-group-foreign-p (group)
2545   "Say whether a group is foreign or not."
2546   (and (not (gnus-group-native-p group))
2547        (not (gnus-group-secondary-p group))))
2548
2549 (defun gnus-group-native-p (group)
2550   "Say whether the group is native or not."
2551   (not (string-match ":" group)))
2552
2553 (defun gnus-group-secondary-p (group)
2554   "Say whether the group is secondary or not."
2555   (gnus-secondary-method-p (gnus-find-method-for-group group)))
2556
2557 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2558   "Return the group parameters for GROUP.
2559 If SYMBOL, return the value of that symbol in the group parameters."
2560   (save-excursion
2561     (set-buffer gnus-group-buffer)
2562     (let ((parameters (funcall gnus-group-get-parameter-function group)))
2563       (if symbol
2564           (gnus-group-parameter-value parameters symbol allow-list)
2565         parameters))))
2566
2567 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2568   "Return the group parameters for GROUP.
2569 If SYMBOL, return the value of that symbol in the group parameters.
2570 Most functions should use `gnus-group-find-parameter', which
2571 also examines the topic parameters."
2572   (let ((params (gnus-info-params (gnus-get-info group))))
2573     (if symbol
2574         (gnus-group-parameter-value params symbol allow-list)
2575       params)))
2576
2577 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2578   "Return the value of SYMBOL in group PARAMS."
2579   ;; We only wish to return group parameters (dotted lists) and
2580   ;; not local variables, which may have the same names.
2581   ;; But first we handle single elements...
2582   (or (car (memq symbol params))
2583       ;; Handle alist.
2584       (let (elem)
2585         (catch 'found
2586           (while (setq elem (pop params))
2587             (when (and (consp elem)
2588                        (eq (car elem) symbol)
2589                        (or allow-list
2590                            (atom (cdr elem))))
2591               (throw 'found (cdr elem))))))))
2592
2593 (defun gnus-group-add-parameter (group param)
2594   "Add parameter PARAM to GROUP."
2595   (let ((info (gnus-get-info group)))
2596     (when info
2597       (gnus-group-remove-parameter group (if (consp param) (car param) param))
2598       ;; Cons the new param to the old one and update.
2599       (gnus-group-set-info (cons param (gnus-info-params info))
2600                            group 'params))))
2601
2602 (defun gnus-group-set-parameter (group name value)
2603   "Set parameter NAME to VALUE in GROUP."
2604   (let ((info (gnus-get-info group)))
2605     (when info
2606       (gnus-group-remove-parameter group name)
2607       (let ((old-params (gnus-info-params info))
2608             (new-params (list (cons name value))))
2609         (while old-params
2610           (when (or (not (listp (car old-params)))
2611                     (not (eq (caar old-params) name)))
2612             (setq new-params (append new-params (list (car old-params)))))
2613           (setq old-params (cdr old-params)))
2614         (gnus-group-set-info new-params group 'params)))))
2615
2616 (defun gnus-group-remove-parameter (group name)
2617   "Remove parameter NAME from GROUP."
2618   (let ((info (gnus-get-info group)))
2619     (when info
2620       (let ((params (gnus-info-params info)))
2621         (when params
2622           (setq params (delq name params))
2623           (while (assq name params)
2624             (gnus-pull name params))
2625           (gnus-info-set-params info params))))))
2626
2627 (defun gnus-group-add-score (group &optional score)
2628   "Add SCORE to the GROUP score.
2629 If SCORE is nil, add 1 to the score of GROUP."
2630   (let ((info (gnus-get-info group)))
2631     (when info
2632       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2633
2634 (defun gnus-short-group-name (group &optional levels)
2635   "Collapse GROUP name LEVELS.
2636 Select methods are stripped and any remote host name is stripped down to
2637 just the host name."
2638   (let* ((name "")
2639          (foreign "")
2640          (depth 0)
2641          (skip 1)
2642          (levels (or levels
2643                      gnus-group-uncollapsed-levels
2644                      (progn
2645                        (while (string-match "\\." group skip)
2646                          (setq skip (match-end 0)
2647                                depth (+ depth 1)))
2648                        depth))))
2649     ;; Separate foreign select method from group name and collapse.
2650     ;; If method contains a server, collapse to non-domain server name,
2651     ;; otherwise collapse to select method.
2652     (let* ((colon (string-match ":" group))
2653            (server (and colon (substring group 0 colon)))
2654            (plus (and server (string-match "+" server))))
2655       (when server
2656         (if plus
2657             (setq foreign (substring server (+ 1 plus)
2658                                      (string-match "\\." server))
2659                   group (substring group (+ 1 colon)))
2660           (setq foreign server
2661                 group (substring group (+ 1 colon))))
2662         (setq foreign (concat foreign ":")))
2663       ;; Collapse group name leaving LEVELS uncollapsed elements
2664       (let* ((glist (split-string group "\\."))
2665              (glen (length glist))
2666              res)
2667         (setq levels (- glen levels))
2668         (dolist (g glist)
2669           (push (if (>= (decf levels) 0)
2670                     (if (zerop (length g))
2671                         ""
2672                       (substring g 0 1))
2673                   g)
2674                 res))
2675         (concat foreign (mapconcat 'identity (nreverse res) "."))))))
2676
2677 (defun gnus-narrow-to-body ()
2678   "Narrow to the body of an article."
2679   (narrow-to-region
2680    (progn
2681      (goto-char (point-min))
2682      (or (search-forward "\n\n" nil t)
2683          (point-max)))
2684    (point-max)))
2685
2686 \f
2687 ;;;
2688 ;;; Kill file handling.
2689 ;;;
2690
2691 (defun gnus-apply-kill-file ()
2692   "Apply a kill file to the current newsgroup.
2693 Returns the number of articles marked as read."
2694   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2695           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2696       (gnus-apply-kill-file-internal)
2697     0))
2698
2699 (defun gnus-kill-save-kill-buffer ()
2700   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2701     (when (get-file-buffer file)
2702       (save-excursion
2703         (set-buffer (get-file-buffer file))
2704         (when (buffer-modified-p)
2705           (save-buffer))
2706         (kill-buffer (current-buffer))))))
2707
2708 (defcustom gnus-kill-file-name "KILL"
2709   "Suffix of the kill files."
2710   :group 'gnus-score-kill
2711   :group 'gnus-score-files
2712   :type 'string)
2713
2714 (defun gnus-newsgroup-kill-file (newsgroup)
2715   "Return the name of a kill file name for NEWSGROUP.
2716 If NEWSGROUP is nil, return the global kill file name instead."
2717   (cond
2718    ;; The global KILL file is placed at top of the directory.
2719    ((or (null newsgroup)
2720         (string-equal newsgroup ""))
2721     (expand-file-name gnus-kill-file-name
2722                       gnus-kill-files-directory))
2723    ;; Append ".KILL" to newsgroup name.
2724    ((gnus-use-long-file-name 'not-kill)
2725     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2726                               "." gnus-kill-file-name)
2727                       gnus-kill-files-directory))
2728    ;; Place "KILL" under the hierarchical directory.
2729    (t
2730     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2731                               "/" gnus-kill-file-name)
2732                       gnus-kill-files-directory))))
2733
2734 ;;; Server things.
2735
2736 (defun gnus-member-of-valid (symbol group)
2737   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2738   (memq symbol (assoc
2739                 (symbol-name (car (gnus-find-method-for-group group)))
2740                 gnus-valid-select-methods)))
2741
2742 (defun gnus-method-option-p (method option)
2743   "Return non-nil if select METHOD has OPTION as a parameter."
2744   (when (stringp method)
2745     (setq method (gnus-server-to-method method)))
2746   (memq option (assoc (format "%s" (car method))
2747                       gnus-valid-select-methods)))
2748
2749 (defun gnus-similar-server-opened (method)
2750   (let ((opened gnus-opened-servers))
2751     (while (and method opened)
2752       (when (and (equal (cadr method) (cadaar opened))
2753                  (equal (car method) (caaar opened))
2754                  (not (equal method (caar opened))))
2755         (setq method nil))
2756       (pop opened))
2757     (not method)))
2758
2759 (defun gnus-server-extend-method (group method)
2760   ;; This function "extends" a virtual server.  If the server is
2761   ;; "hello", and the select method is ("hello" (my-var "something"))
2762   ;; in the group "alt.alt", this will result in a new virtual server
2763   ;; called "hello+alt.alt".
2764   (if (or (not (inline (gnus-similar-server-opened method)))
2765           (not (cddr method)))
2766       method
2767     `(,(car method) ,(concat (cadr method) "+" group)
2768       (,(intern (format "%s-address" (car method))) ,(cadr method))
2769       ,@(cddr method))))
2770
2771 (defun gnus-server-status (method)
2772   "Return the status of METHOD."
2773   (nth 1 (assoc method gnus-opened-servers)))
2774
2775 (defun gnus-group-name-to-method (group)
2776   "Guess a select method based on GROUP."
2777   (if (string-match ":" group)
2778       (let ((server (substring group 0 (match-beginning 0))))
2779         (if (string-match "\\+" server)
2780             (list (intern (substring server 0 (match-beginning 0)))
2781                   (substring server (match-end 0)))
2782           (list (intern server) "")))
2783     gnus-select-method))
2784
2785 (defun gnus-find-method-for-group (group &optional info)
2786   "Find the select method that GROUP uses."
2787   (or gnus-override-method
2788       (and (not group)
2789            gnus-select-method)
2790       (and (not (gnus-group-entry group));; a new group
2791            (gnus-group-name-to-method group))
2792       (let ((info (or info (gnus-get-info group)))
2793             method)
2794         (if (or (not info)
2795                 (not (setq method (gnus-info-method info)))
2796                 (equal method "native"))
2797             gnus-select-method
2798           (setq method
2799                 (cond ((stringp method)
2800                        (inline (gnus-server-to-method method)))
2801                       ((stringp (cadr method))
2802                        (inline (gnus-server-extend-method group method)))
2803                       (t
2804                        method)))
2805           (cond ((equal (cadr method) "")
2806                  method)
2807                 ((null (cadr method))
2808                  (list (car method) ""))
2809                 (t
2810                  (gnus-server-add-address method)))))))
2811
2812 (defun gnus-methods-using (feature)
2813   "Find all methods that have FEATURE."
2814   (let ((valids gnus-valid-select-methods)
2815         outs)
2816     (while valids
2817       (when (memq feature (car valids))
2818         (push (car valids) outs))
2819       (setq valids (cdr valids)))
2820     outs))
2821
2822 (defun gnus-read-group (prompt &optional default)
2823   "Prompt the user for a group name.
2824 Disallow invalid group names."
2825   (let ((prefix "")
2826         group)
2827     (while (not group)
2828       (when (string-match
2829              "[: `'\"/]\\|^$"
2830              (setq group (read-string (concat prefix prompt)
2831                                       (cons (or default "") 0)
2832                                       'gnus-group-history)))
2833         (setq prefix (format "Invalid group name: \"%s\".  " group)
2834               group nil)))
2835     group))
2836
2837 (defun gnus-read-method (prompt)
2838   "Prompt the user for a method.
2839 Allow completion over sensible values."
2840   (let* ((servers
2841           (append gnus-valid-select-methods
2842                   (mapcar (lambda (i) (list (format "%s:%s" (caar i)
2843                                                     (cadar i))))
2844                           gnus-opened-servers)
2845                   gnus-predefined-server-alist
2846                   gnus-server-alist))
2847          (method
2848           (completing-read
2849            prompt servers
2850            nil t nil 'gnus-method-history)))
2851     (cond
2852      ((equal method "")
2853       (setq method gnus-select-method))
2854      ((assoc method gnus-valid-select-methods)
2855       (let ((address (if (memq 'prompt-address
2856                                (assoc method gnus-valid-select-methods))
2857                          (read-string "Address: ")
2858                        "")))
2859         (or (let ((opened gnus-opened-servers))
2860               (while (and opened
2861                           (not (equal (format "%s:%s" method address)
2862                                       (format "%s:%s" (caaar opened)
2863                                               (cadaar opened)))))
2864                 (pop opened))
2865               (caar opened))
2866             (list (intern method) address))))
2867      ((assoc method servers)
2868       method)
2869      (t
2870       (list (intern method) "")))))
2871
2872 ;;; User-level commands.
2873
2874 ;;;###autoload
2875 (defun gnus-slave-no-server (&optional arg)
2876   "Read network news as a slave, without connecting to local server."
2877   (interactive "P")
2878   (gnus-no-server arg t))
2879
2880 ;;;###autoload
2881 (defun gnus-no-server (&optional arg slave)
2882   "Read network news.
2883 If ARG is a positive number, Gnus will use that as the
2884 startup level.  If ARG is nil, Gnus will be started at level 2.
2885 If ARG is non-nil and not a positive number, Gnus will
2886 prompt the user for the name of an NNTP server to use.
2887 As opposed to `gnus', this command will not connect to the local server."
2888   (interactive "P")
2889   (gnus-no-server-1 arg slave))
2890
2891 ;;;###autoload
2892 (defun gnus-slave (&optional arg)
2893   "Read news as a slave."
2894   (interactive "P")
2895   (gnus arg nil 'slave))
2896
2897 (defcustom gnus-frame-properties nil
2898   "The properties of the frame in which gnus is displayed. Under XEmacs,
2899 the variable `toolbar-news-frame-plist' will be refered instead."
2900   :type '(repeat (cons :format "%v"
2901                        (symbol :tag "Parameter")
2902                        (sexp :tag "Value")))
2903   :group 'gnus)
2904
2905 (defvar gnus-frame nil
2906   "The frame in which gnus is displayed. It is not used under XEmacs.")
2907
2908 ;;;###autoload
2909 (defun gnus-other-frame (&optional arg)
2910   "Pop up a frame to read news."
2911   (interactive "P")
2912   (static-if (featurep 'xemacs)
2913       (let ((toolbar-news-use-separate-frame t))
2914         (toolbar-gnus))
2915     (if (frame-live-p gnus-frame)
2916         (raise-frame gnus-frame)
2917       (setq gnus-frame (make-frame gnus-frame-properties))
2918       (if (and (gnus-buffer-live-p gnus-group-buffer)
2919                (save-current-buffer
2920                  (set-buffer gnus-group-buffer)
2921                  (eq 'gnus-group-mode major-mode)))
2922           (progn
2923             (select-frame gnus-frame)
2924             (switch-to-buffer gnus-group-buffer))
2925         (add-hook 'gnus-exit-gnus-hook
2926                   (lambda ()
2927                     (when (and (frame-live-p gnus-frame)
2928                                (cdr (frame-list)))
2929                       (delete-frame gnus-frame))
2930                     (setq gnus-frame nil)))
2931         (select-frame gnus-frame)
2932         (gnus arg)))))
2933
2934 ;;;###autoload
2935 (defun gnus (&optional arg dont-connect slave)
2936   "Read network news.
2937 If ARG is non-nil and a positive number, Gnus will use that as the
2938 startup level.  If ARG is non-nil and not a positive number, Gnus will
2939 prompt the user for the name of an NNTP server to use."
2940   (interactive "P")
2941   (gnus-1 arg dont-connect slave))
2942
2943 ;; Allow redefinition of Gnus functions.
2944
2945 (gnus-ems-redefine)
2946
2947 (product-provide (provide 'gnus) 'gnus-vers)
2948
2949 ;;; gnus.el ends here