cgit.sxemacs.org Git - gnus/blob - lisp/gnus.el

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