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

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