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