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

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