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

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