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

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