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

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