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

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