git.chise.org Git - elisp/gnus.git-/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,99 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.70"
 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-scoring t
1154   "*If non-nil, enable scoring."
1155   :group 'gnus-meta
1156   :type 'boolean)
1157
1158 (defcustom gnus-use-picons nil
1159   "*If non-nil, display picons."
1160   :group 'gnus-meta
1161   :type 'boolean)
1162
1163 (defcustom gnus-summary-prepare-exit-hook
1164   '(gnus-summary-expire-articles)
1165   "*A hook called when preparing to exit from the summary buffer.
1166 It calls `gnus-summary-expire-articles' by default."
1167   :group 'gnus-summary-exit
1168   :type 'hook)
1169
1170 (defcustom gnus-novice-user t
1171   "*Non-nil means that you are a usenet novice.
1172 If non-nil, verbose messages may be displayed and confirmations may be
1173 required."
1174   :group 'gnus-meta
1175   :type 'boolean)
1176
1177 (defcustom gnus-expert-user nil
1178   "*Non-nil means that you will never be asked for confirmation about anything.
1179 That doesn't mean *anything* anything; particularly destructive
1180 commands will still require prompting."
1181   :group 'gnus-meta
1182   :type 'boolean)
1183
1184 (defcustom gnus-interactive-catchup t
1185   "*If non-nil, require your confirmation when catching up a group."
1186   :group 'gnus-group-select
1187   :type 'boolean)
1188
1189 (defcustom gnus-interactive-exit t
1190   "*If non-nil, require your confirmation when exiting Gnus."
1191   :group 'gnus-exit
1192   :type 'boolean)
1193
1194 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1195   "*Function for extracting address components from a From header.
1196 Two pre-defined function exist: `gnus-extract-address-components',
1197 which is the default, quite fast, and too simplistic solution, and
1198 `mail-extract-address-components', which works much better, but is
1199 slower."
1200   :group 'gnus-summary-format
1201   :type '(radio (function-item gnus-extract-address-components)
1202                 (function-item mail-extract-address-components)
1203                 (function :tag "Other")))
1204
1205 (defcustom gnus-carpal nil
1206   "*If non-nil, display clickable icons."
1207   :group 'gnus-meta
1208   :type 'boolean)
1209
1210 (defcustom gnus-shell-command-separator ";"
1211   "String used to separate to shell commands."
1212   :group 'gnus-files
1213   :type 'string)
1214
1215 (defcustom gnus-valid-select-methods
1216   '(("nntp" post address prompt-address physical-address)
1217     ("nnspool" post address)
1218     ("nnvirtual" post-mail virtual prompt-address)
1219     ("nnmbox" mail respool address)
1220     ("nnml" mail respool address)
1221     ("nnmh" mail respool address)
1222     ("nndir" post-mail prompt-address physical-address)
1223     ("nneething" none address prompt-address physical-address)
1224     ("nndoc" none address prompt-address)
1225     ("nnbabyl" mail address respool)
1226     ("nnkiboze" post virtual)
1227     ("nnsoup" post-mail address)
1228     ("nndraft" post-mail)
1229     ("nnfolder" mail respool address)
1230     ("nngateway" post-mail address prompt-address physical-address)
1231     ("nnweb" none)
1232     ("nnlistserv" none)
1233     ("nnagent" post-mail))
1234   "*An alist of valid select methods.
1235 The first element of each list lists should be a string with the name
1236 of the select method.  The other elements may be the category of
1237 this method (i. e., `post', `mail', `none' or whatever) or other
1238 properties that this method has (like being respoolable).
1239 If you implement a new select method, all you should have to change is
1240 this variable.  I think."
1241   :group 'gnus-server
1242   :type '(repeat (group (string :tag "Name")
1243                         (radio-button-choice (const :format "%v " post)
1244                                              (const :format "%v " mail)
1245                                              (const :format "%v " none)
1246                                              (const post-mail))
1247                         (checklist :inline t
1248                                    (const :format "%v " address)
1249                                    (const :format "%v " prompt-address)
1250                                    (const :format "%v " physical-address)
1251                                    (const :format "%v " virtual)
1252                                    (const respool)))))
1253
1254 (define-widget 'gnus-select-method 'list
1255   "Widget for entering a select method."
1256   :args `((choice :tag "Method"
1257                   ,@(mapcar (lambda (entry)
1258                               (list 'const :format "%v\n"
1259                                     (intern (car entry))))
1260                             gnus-valid-select-methods))
1261           (string :tag "Address")
1262           (editable-list  :inline t
1263                           (list :format "%v"
1264                                 variable
1265                                 (sexp :tag "Value")))))
1266
1267 (defcustom gnus-updated-mode-lines '(group article summary tree)
1268   "List of buffers that should update their mode lines.
1269 The list may contain the symbols `group', `article', `tree' and
1270 `summary'.  If the corresponding symbol is present, Gnus will keep
1271 that mode line updated with information that may be pertinent.
1272 If this variable is nil, screen refresh may be quicker."
1273   :group 'gnus-various
1274   :type '(set (const group)
1275               (const article)
1276               (const summary)
1277               (const tree)))
1278
1279 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1280 (defcustom gnus-mode-non-string-length nil
1281   "*Max length of mode-line non-string contents.
1282 If this is nil, Gnus will take space as is needed, leaving the rest
1283 of the modeline intact.  Note that the default of nil is unlikely
1284 to be desirable; see the manual for further details."
1285   :group 'gnus-various
1286   :type '(choice (const nil)
1287                  integer))
1288
1289 (defcustom gnus-auto-expirable-newsgroups nil
1290   "*Groups in which to automatically mark read articles as expirable.
1291 If non-nil, this should be a regexp that should match all groups in
1292 which to perform auto-expiry.  This only makes sense for mail groups."
1293   :group 'nnmail-expire
1294   :type '(choice (const nil)
1295                  regexp))
1296
1297 (defcustom gnus-total-expirable-newsgroups nil
1298   "*Groups in which to perform expiry of all read articles.
1299 Use with extreme caution.  All groups that match this regexp will be
1300 expiring - which means that all read articles will be deleted after
1301 \(say) one week.         (This only goes for mail groups and the like, of
1302 course.)"
1303   :group 'nnmail-expire
1304   :type '(choice (const nil)
1305                  regexp))
1306
1307 (defcustom gnus-group-uncollapsed-levels 1
1308   "Number of group name elements to leave alone when making a short group name."
1309   :group 'gnus-group-visual
1310   :type 'integer)
1311
1312 (defcustom gnus-group-use-permanent-levels nil
1313   "*If non-nil, once you set a level, Gnus will use this level."
1314   :group 'gnus-group-levels
1315   :type 'boolean)
1316
1317 ;; Hooks.
1318
1319 (defcustom gnus-load-hook nil
1320   "A hook run while Gnus is loaded."
1321   :group 'gnus-start
1322   :type 'hook)
1323
1324 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1325   "A hook called to apply kill files to a group.
1326 This hook is intended to apply a kill file to the selected newsgroup.
1327 The function `gnus-apply-kill-file' is called by default.
1328
1329 Since a general kill file is too heavy to use only for a few
1330 newsgroups, I recommend you to use a lighter hook function.  For
1331 example, if you'd like to apply a kill file to articles which contains
1332 a string `rmgroup' in subject in newsgroup `control', you can use the
1333 following hook:
1334
1335  (setq gnus-apply-kill-hook
1336       (list
1337         (lambda ()
1338           (cond ((string-match \"control\" gnus-newsgroup-name)
1339                  (gnus-kill \"Subject\" \"rmgroup\")
1340                  (gnus-expunge \"X\"))))))"
1341   :group 'gnus-score-kill
1342   :options '(gnus-apply-kill-file)
1343   :type 'hook)
1344
1345 (defcustom gnus-group-change-level-function nil
1346   "Function run when a group level is changed.
1347 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1348   :group 'gnus-group-level
1349   :type 'function)
1350
1351 ;;; Face thingies.
1352
1353 (defcustom gnus-visual
1354   '(summary-highlight group-highlight article-highlight
1355                       mouse-face
1356                       summary-menu group-menu article-menu
1357                       tree-highlight menu highlight
1358                       browse-menu server-menu
1359                       page-marker tree-menu binary-menu pick-menu
1360                       grouplens-menu)
1361   "*Enable visual features.
1362 If `visual' is disabled, there will be no menus and few faces.  Most of
1363 the visual customization options below will be ignored.  Gnus will use
1364 less space and be faster as a result.
1365
1366 This variable can also be a list of visual elements to switch on.  For
1367 instance, to switch off all visual things except menus, you can say:
1368
1369    (setq gnus-visual '(menu))
1370
1371 Valid elements include `summary-highlight', `group-highlight',
1372 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1373 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1374 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1375 and `grouplens-menu'."
1376   :group 'gnus-meta
1377   :group 'gnus-visual
1378   :type '(set (const summary-highlight)
1379               (const group-highlight)
1380               (const article-highlight)
1381               (const mouse-face)
1382               (const summary-menu)
1383               (const group-menu)
1384               (const article-menu)
1385               (const tree-highlight)
1386               (const menu)
1387               (const highlight)
1388               (const browse-menu)
1389               (const server-menu)
1390               (const page-marker)
1391               (const tree-menu)
1392               (const binary-menu)
1393               (const pick-menu)
1394               (const grouplens-menu)))
1395
1396 (defcustom gnus-mouse-face
1397   (condition-case ()
1398       (if (gnus-visual-p 'mouse-face 'highlight)
1399           (if (boundp 'gnus-mouse-face)
1400               (or gnus-mouse-face 'highlight)
1401             'highlight)
1402         'default)
1403     (error 'highlight))
1404   "*Face used for group or summary buffer mouse highlighting.
1405 The line beneath the mouse pointer will be highlighted with this
1406 face."
1407   :group 'gnus-visual
1408   :type 'face)
1409
1410 (defcustom gnus-article-display-hook
1411   (if (and (string-match "XEmacs" emacs-version)
1412            (featurep 'xface))
1413       '(gnus-article-hide-headers-if-wanted
1414         gnus-article-hide-boring-headers
1415         gnus-article-treat-overstrike
1416         gnus-article-maybe-highlight
1417         gnus-article-display-x-face)
1418     '(gnus-article-hide-headers-if-wanted
1419       gnus-article-hide-boring-headers
1420       gnus-article-treat-overstrike
1421       gnus-article-maybe-highlight))
1422   "*Controls how the article buffer will look.
1423
1424 If you leave the list empty, the article will appear exactly as it is
1425 stored on the disk.  The list entries will hide or highlight various
1426 parts of the article, making it easier to find the information you
1427 want."
1428   :group 'gnus-article-highlight
1429   :group 'gnus-visual
1430   :type 'hook
1431   :options '(gnus-article-add-buttons
1432              gnus-article-add-buttons-to-head
1433              gnus-article-emphasize
1434              gnus-article-fill-cited-article
1435              gnus-article-remove-cr
1436              gnus-article-de-quoted-unreadable
1437              gnus-summary-stop-page-breaking
1438              ;; gnus-summary-caesar-message
1439              ;; gnus-summary-verbose-headers
1440              gnus-article-hide
1441              gnus-article-hide-headers
1442              gnus-article-hide-boring-headers
1443              gnus-article-hide-signature
1444              gnus-article-hide-citation
1445              gnus-article-hide-pgp
1446              gnus-article-hide-pem
1447              gnus-article-highlight
1448              gnus-article-highlight-headers
1449              gnus-article-highlight-citation
1450              gnus-article-highlight-signature
1451              gnus-article-date-ut
1452              gnus-article-date-local
1453              gnus-article-date-lapsed
1454              gnus-article-date-original
1455              gnus-article-remove-trailing-blank-lines
1456              gnus-article-strip-leading-blank-lines
1457              gnus-article-strip-multiple-blank-lines
1458              gnus-article-strip-blank-lines
1459              gnus-article-treat-overstrike
1460              gnus-article-display-x-face
1461              gnus-smiley-display))
1462
1463 (defcustom gnus-article-save-directory gnus-directory
1464   "*Name of the directory articles will be saved in (default \"~/News\")."
1465   :group 'gnus-article-saving
1466   :type 'directory)
1467
1468 (defvar gnus-plugged t
1469   "Whether Gnus is plugged or not.")
1470
1471 \f
1472 ;;; Internal variables
1473
1474 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1475 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1476 (defvar gnus-original-article-buffer " *Original Article*")
1477 (defvar gnus-newsgroup-name nil)
1478 (defvar gnus-ephemeral-servers nil)
1479
1480 (defvar gnus-agent nil
1481   "Whether we want to use the Gnus agent or not.")
1482
1483 (defvar gnus-command-method nil
1484   "Dynamically bound variable that says what the current backend is.")
1485
1486 (defvar gnus-current-select-method nil
1487   "The current method for selecting a newsgroup.")
1488
1489 (defvar gnus-tree-buffer "*Tree*"
1490   "Buffer where Gnus thread trees are displayed.")
1491
1492 ;; Dummy variable.
1493 (defvar gnus-use-generic-from nil)
1494
1495 ;; Variable holding the user answers to all method prompts.
1496 (defvar gnus-method-history nil)
1497
1498 ;; Variable holding the user answers to all mail method prompts.
1499 (defvar gnus-mail-method-history nil)
1500
1501 ;; Variable holding the user answers to all group prompts.
1502 (defvar gnus-group-history nil)
1503
1504 (defvar gnus-server-alist nil
1505   "List of available servers.")
1506
1507 (defcustom gnus-cache-directory
1508   (nnheader-concat gnus-directory "cache/")
1509   "*The directory where cached articles will be stored."
1510   :group 'gnus-cache
1511   :type 'directory)
1512
1513 (defvar gnus-predefined-server-alist
1514   `(("cache"
1515      nnspool "cache"
1516      (nnspool-spool-directory ,gnus-cache-directory)
1517      (nnspool-nov-directory ,gnus-cache-directory)
1518      (nnspool-active-file
1519       ,(nnheader-concat gnus-cache-directory "active"))))
1520   "List of predefined (convenience) servers.")
1521
1522 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1523
1524 (defconst gnus-article-mark-lists
1525   '((marked . tick) (replied . reply)
1526     (expirable . expire) (killed . killed)
1527     (bookmarks . bookmark) (dormant . dormant)
1528     (scored . score) (saved . save)
1529     (cached . cache) (downloadable . download)
1530     (unsendable . unsend)))
1531
1532 (defvar gnus-headers-retrieved-by nil)
1533 (defvar gnus-article-reply nil)
1534 (defvar gnus-override-method nil)
1535 (defvar gnus-article-check-size nil)
1536 (defvar gnus-opened-servers nil)
1537
1538 (defvar gnus-current-kill-article nil)
1539
1540 (defvar gnus-have-read-active-file nil)
1541
1542 (defconst gnus-maintainer
1543   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1544   "The mail address of the Gnus maintainers.")
1545
1546 (defvar gnus-info-nodes
1547   '((gnus-group-mode "(gnus)The Group Buffer")
1548     (gnus-summary-mode "(gnus)The Summary Buffer")
1549     (gnus-article-mode "(gnus)The Article Buffer")
1550     (gnus-server-mode "(gnus)The Server Buffer")
1551     (gnus-browse-mode "(gnus)Browse Foreign Server")
1552     (gnus-tree-mode "(gnus)Tree Display"))
1553   "Alist of major modes and related Info nodes.")
1554
1555 (defvar gnus-group-buffer "*Group*")
1556 (defvar gnus-summary-buffer "*Summary*")
1557 (defvar gnus-article-buffer "*Article*")
1558 (defvar gnus-server-buffer "*Server*")
1559
1560 (defvar gnus-slave nil
1561   "Whether this Gnus is a slave or not.")
1562
1563 (defvar gnus-batch-mode nil
1564   "Whether this Gnus is running in batch mode or not.")
1565
1566 (defvar gnus-variable-list
1567   '(gnus-newsrc-options gnus-newsrc-options-n
1568     gnus-newsrc-last-checked-date
1569     gnus-newsrc-alist gnus-server-alist
1570     gnus-killed-list gnus-zombie-list
1571     gnus-topic-topology gnus-topic-alist
1572     gnus-format-specs)
1573   "Gnus variables saved in the quick startup file.")
1574
1575 (defvar gnus-newsrc-alist nil
1576   "Assoc list of read articles.
1577 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1578
1579 (defvar gnus-newsrc-hashtb nil
1580   "Hashtable of gnus-newsrc-alist.")
1581
1582 (defvar gnus-killed-list nil
1583   "List of killed newsgroups.")
1584
1585 (defvar gnus-killed-hashtb nil
1586   "Hash table equivalent of gnus-killed-list.")
1587
1588 (defvar gnus-zombie-list nil
1589   "List of almost dead newsgroups.")
1590
1591 (defvar gnus-description-hashtb nil
1592   "Descriptions of newsgroups.")
1593
1594 (defvar gnus-list-of-killed-groups nil
1595   "List of newsgroups that have recently been killed by the user.")
1596
1597 (defvar gnus-active-hashtb nil
1598   "Hashtable of active articles.")
1599
1600 (defvar gnus-moderated-hashtb nil
1601   "Hashtable of moderated newsgroups.")
1602
1603 ;; Save window configuration.
1604 (defvar gnus-prev-winconf nil)
1605
1606 (defvar gnus-reffed-article-number nil)
1607
1608 ;;; Let the byte-compiler know that we know about this variable.
1609 (defvar rmail-default-rmail-file)
1610
1611 (defvar gnus-dead-summary nil)
1612
1613 ;;; End of variables.
1614
1615 ;; Define some autoload functions Gnus might use.
1616 (eval-and-compile
1617
1618   ;; This little mapcar goes through the list below and marks the
1619   ;; symbols in question as autoloaded functions.
1620   (mapcar
1621    (lambda (package)
1622      (let ((interactive (nth 1 (memq ':interactive package))))
1623        (mapcar
1624         (lambda (function)
1625           (let (keymap)
1626             (when (consp function)
1627               (setq keymap (car (memq 'keymap function)))
1628               (setq function (car function)))
1629             (autoload function (car package) nil interactive keymap)))
1630         (if (eq (nth 1 package) ':interactive)
1631             (cdddr package)
1632           (cdr package)))))
1633    '(("metamail" metamail-buffer)
1634      ("info" Info-goto-node)
1635      ("pp" pp pp-to-string pp-eval-expression)
1636      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
1637      ("ps-print" ps-print-preprint)
1638      ("mail-extr" mail-extract-address-components)
1639      ("browse-url" browse-url)
1640      ("message" :interactive t
1641       message-send-and-exit message-yank-original)
1642      ("nnmail" nnmail-split-fancy nnmail-article-group)
1643      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
1644      ("rmailout" rmail-output rmail-output-to-rmail-file)
1645      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
1646       rmail-show-message rmail-summary-exists
1647       rmail-select-summary rmail-update-summary)
1648      ("gnus-audio" :interactive t gnus-audio-play)
1649      ("gnus-xmas" gnus-xmas-splash)
1650      ("gnus-soup" :interactive t
1651       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
1652       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
1653      ("nnsoup" nnsoup-pack-replies)
1654      ("score-mode" :interactive t gnus-score-mode)
1655      ("gnus-mh" gnus-summary-save-article-folder
1656       gnus-Folder-save-name gnus-folder-save-name)
1657      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
1658      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
1659       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
1660       gnus-demon-add-disconnection gnus-demon-add-handler
1661       gnus-demon-remove-handler)
1662      ("gnus-demon" :interactive t
1663       gnus-demon-init gnus-demon-cancel)
1664      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
1665       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
1666      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
1667       gnus-nocem-unwanted-article-p)
1668      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
1669       gnus-server-server-name)
1670      ("gnus-srvr" gnus-browse-foreign-server)
1671      ("gnus-cite" :interactive t
1672       gnus-article-highlight-citation gnus-article-hide-citation-maybe
1673       gnus-article-hide-citation gnus-article-fill-cited-article
1674       gnus-article-hide-citation-in-followups)
1675      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
1676       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
1677       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
1678      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
1679       gnus-cache-possibly-remove-articles gnus-cache-request-article
1680       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
1681       gnus-cache-enter-remove-article gnus-cached-article-p
1682       gnus-cache-open gnus-cache-close gnus-cache-update-article)
1683       ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
1684        gnus-cache-remove-article gnus-summary-insert-cached-articles)
1685       ("gnus-score" :interactive t
1686        gnus-summary-increase-score gnus-summary-set-score
1687        gnus-summary-raise-thread gnus-summary-raise-same-subject
1688        gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
1689        gnus-summary-lower-thread gnus-summary-lower-same-subject
1690        gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
1691        gnus-summary-current-score gnus-score-default
1692        gnus-score-flush-cache gnus-score-close
1693        gnus-possibly-score-headers gnus-score-followup-article
1694        gnus-score-followup-thread)
1695       ("gnus-score"
1696        (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
1697       gnus-current-score-file-nondirectory gnus-score-adaptive
1698       gnus-score-find-trace gnus-score-file-name)
1699      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
1700      ("gnus-topic" :interactive t gnus-topic-mode)
1701      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters)
1702      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
1703      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
1704      ("gnus-uu" :interactive t
1705       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
1706       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
1707       gnus-uu-mark-by-regexp gnus-uu-mark-all
1708       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
1709       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
1710       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
1711       gnus-uu-decode-binhex gnus-uu-decode-uu-view
1712       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
1713       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
1714       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
1715       gnus-uu-mark-over gnus-uu-post-news)
1716      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
1717      ("gnus-msg" (gnus-summary-send-map keymap)
1718       gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
1719      ("gnus-msg" :interactive t
1720       gnus-group-post-news gnus-group-mail gnus-summary-post-news
1721       gnus-summary-followup gnus-summary-followup-with-original
1722       gnus-summary-cancel-article gnus-summary-supersede-article
1723       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
1724       gnus-summary-mail-forward gnus-summary-mail-other-window
1725       gnus-summary-resend-message gnus-summary-resend-bounced-mail
1726       gnus-summary-wide-reply gnus-summary-followup-to-mail
1727       gnus-summary-followup-to-mail-with-original gnus-bug
1728       gnus-summary-wide-reply-with-original
1729       gnus-summary-post-forward gnus-summary-wide-reply-with-original
1730       gnus-summary-post-forward)
1731      ("gnus-picon" :interactive t gnus-article-display-picons
1732       gnus-group-display-picons gnus-picons-article-display-x-face
1733       gnus-picons-display-x-face)
1734      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
1735       gnus-grouplens-mode)
1736      ("smiley" :interactive t gnus-smiley-display)
1737      ("gnus-win" gnus-configure-windows gnus-add-configuration)
1738      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
1739       gnus-list-of-unread-articles gnus-list-of-read-articles
1740       gnus-offer-save-summaries gnus-make-thread-indent-array
1741       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
1742       gnus-summary-skip-intangible gnus-summary-article-number
1743       gnus-data-header gnus-data-find)
1744      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
1745       gnus-group-list-groups gnus-group-first-unread-group
1746       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
1747       gnus-group-setup-buffer gnus-group-get-new-news
1748       gnus-group-make-help-group gnus-group-update-group
1749       gnus-clear-inboxes-moved gnus-group-iterate
1750       gnus-group-group-name)
1751      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
1752       gnus-backlog-remove-article)
1753      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
1754       gnus-article-prepare gnus-article-set-window-start
1755       gnus-article-next-page gnus-article-prev-page
1756       gnus-request-article-this-buffer gnus-article-mode
1757       gnus-article-setup-buffer gnus-narrow-to-page
1758       gnus-article-delete-invisible-text)
1759      ("gnus-art" :interactive t
1760       gnus-article-hide-headers gnus-article-hide-boring-headers
1761       gnus-article-treat-overstrike gnus-article-word-wrap
1762       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
1763       gnus-article-display-x-face gnus-article-de-quoted-unreadable
1764       gnus-article-hide-pgp
1765       gnus-article-hide-pem gnus-article-hide-signature
1766       gnus-article-strip-leading-blank-lines gnus-article-date-local
1767       gnus-article-date-original gnus-article-date-lapsed
1768       gnus-article-show-all-headers
1769       gnus-article-edit-mode gnus-article-edit-article
1770       gnus-article-edit-done gnus-article-decode-encoded-words
1771       gnus-start-date-timer gnus-stop-date-timer
1772       gnus-mime-view-all-parts)
1773      ("gnus-int" gnus-request-type)
1774      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
1775       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
1776      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
1777       gnus-dup-enter-articles)
1778      ("gnus-range" gnus-copy-sequence)
1779      ("gnus-eform" gnus-edit-form)
1780      ("gnus-move" :interactive t
1781       gnus-group-move-group-to-server gnus-change-server)
1782      ("gnus-logic" gnus-score-advanced)
1783      ("gnus-undo" gnus-undo-mode gnus-undo-register)
1784      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
1785       gnus-async-prefetch-article gnus-async-prefetch-remove-group
1786       gnus-async-halt-prefetch)
1787      ("gnus-agent" gnus-open-agent gnus-agent-get-function
1788       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
1789       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
1790       gnus-summary-set-agent-mark gnus-agent-save-group-info)
1791      ("gnus-agent" :interactive t
1792       gnus-unplugged gnus-agentize gnus-agent-batch)
1793      ("gnus-vm" :interactive t gnus-summary-save-in-vm
1794       gnus-summary-save-article-vm)
1795      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-drafts))))
1796
1797 ;;; gnus-sum.el thingies
1798
1799
1800 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-20,20n%]%) %s\n"
1801   "*The format specification of the lines in the summary buffer.
1802
1803 It works along the same lines as a normal formatting string,
1804 with some simple extensions.
1805
1806 %N   Article number, left padded with spaces (string)
1807 %S   Subject (string)
1808 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
1809 %n   Name of the poster (string)
1810 %a   Extracted name of the poster (string)
1811 %A   Extracted address of the poster (string)
1812 %F   Contents of the From: header (string)
1813 %f   Contents of the From: or To: headers (string)
1814 %x   Contents of the Xref: header (string)
1815 %D   Date of the article (string)
1816 %d   Date of the article (string) in DD-MMM format
1817 %M   Message-id of the article (string)
1818 %r   References of the article (string)
1819 %c   Number of characters in the article (integer)
1820 %L   Number of lines in the article (integer)
1821 %I   Indentation based on thread level (a string of spaces)
1822 %T   A string with two possible values: 80 spaces if the article
1823      is on thread level two or larger and 0 spaces on level one
1824 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
1825 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
1826 %[   Opening bracket (character, \"[\" or \"<\")
1827 %]   Closing bracket (character, \"]\" or \">\")
1828 %>   Spaces of length thread-level (string)
1829 %<   Spaces of length (- 20 thread-level) (string)
1830 %i   Article score (number)
1831 %z   Article zcore (character)
1832 %t   Number of articles under the current thread (number).
1833 %e   Whether the thread is empty or not (character).
1834 %l   GroupLens score (string).
1835 %V   Total thread score (number).
1836 %P   The line number (number).
1837 %O   Download mark (character).
1838 %u   User defined specifier.  The next character in the format string should
1839      be a letter.  Gnus will call the function gnus-user-format-function-X,
1840      where X is the letter following %u.  The function will be passed the
1841      current header as argument.  The function should return a string, which
1842      will be inserted into the summary just like information from any other
1843      summary specifier.
1844
1845 Text between %( and %) will be highlighted with `gnus-mouse-face'
1846 when the mouse point is placed inside the area.  There can only be one
1847 such area.
1848
1849 The %U (status), %R (replied) and %z (zcore) specs have to be handled
1850 with care.  For reasons of efficiency, Gnus will compute what column
1851 these characters will end up in, and \"hard-code\" that.  This means that
1852 it is illegal to have these specs after a variable-length spec.  Well,
1853 you might not be arrested, but your summary buffer will look strange,
1854 which is bad enough.
1855
1856 The smart choice is to have these specs as for to the left as
1857 possible.
1858
1859 This restriction may disappear in later versions of Gnus."
1860   :type 'string
1861   :group 'gnus-summary-format)
1862
1863 ;;;
1864 ;;; Skeleton keymaps
1865 ;;;
1866
1867 (defun gnus-suppress-keymap (keymap)
1868   (suppress-keymap keymap)
1869   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
1870     (while keys
1871       (define-key keymap (pop keys) 'undefined))))
1872
1873 (defvar gnus-article-mode-map
1874   (let ((keymap (make-sparse-keymap)))
1875     (gnus-suppress-keymap keymap)
1876     keymap))
1877 (defvar gnus-summary-mode-map
1878   (let ((keymap (make-keymap)))
1879     (gnus-suppress-keymap keymap)
1880     keymap))
1881 (defvar gnus-group-mode-map
1882   (let ((keymap (make-keymap)))
1883     (gnus-suppress-keymap keymap)
1884     keymap))
1885
1886 \f
1887
1888 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
1889 ;; If you want the cursor to go somewhere else, set these two
1890 ;; functions in some startup hook to whatever you want.
1891 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
1892 (defalias 'gnus-group-position-point 'gnus-goto-colon)
1893
1894 ;;; Various macros and substs.
1895
1896 (defun gnus-header-from (header)
1897   (mail-header-from header))
1898
1899 (defmacro gnus-gethash (string hashtable)
1900   "Get hash value of STRING in HASHTABLE."
1901   `(symbol-value (intern-soft ,string ,hashtable)))
1902
1903 (defmacro gnus-sethash (string value hashtable)
1904   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
1905   `(set (intern ,string ,hashtable) ,value))
1906 (put 'gnus-sethash 'edebug-form-spec '(form form form))
1907
1908 (defmacro gnus-group-unread (group)
1909   "Get the currently computed number of unread articles in GROUP."
1910   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
1911
1912 (defmacro gnus-group-entry (group)
1913   "Get the newsrc entry for GROUP."
1914   `(gnus-gethash ,group gnus-newsrc-hashtb))
1915
1916 (defmacro gnus-active (group)
1917   "Get active info on GROUP."
1918   `(gnus-gethash ,group gnus-active-hashtb))
1919
1920 (defmacro gnus-set-active (group active)
1921   "Set GROUP's active info."
1922   `(gnus-sethash ,group ,active gnus-active-hashtb))
1923
1924 ;; Info access macros.
1925
1926 (defmacro gnus-info-group (info)
1927   `(nth 0 ,info))
1928 (defmacro gnus-info-rank (info)
1929   `(nth 1 ,info))
1930 (defmacro gnus-info-read (info)
1931   `(nth 2 ,info))
1932 (defmacro gnus-info-marks (info)
1933   `(nth 3 ,info))
1934 (defmacro gnus-info-method (info)
1935   `(nth 4 ,info))
1936 (defmacro gnus-info-params (info)
1937   `(nth 5 ,info))
1938
1939 (defmacro gnus-info-level (info)
1940   `(let ((rank (gnus-info-rank ,info)))
1941      (if (consp rank)
1942          (car rank)
1943        rank)))
1944 (defmacro gnus-info-score (info)
1945   `(let ((rank (gnus-info-rank ,info)))
1946      (or (and (consp rank) (cdr rank)) 0)))
1947
1948 (defmacro gnus-info-set-group (info group)
1949   `(setcar ,info ,group))
1950 (defmacro gnus-info-set-rank (info rank)
1951   `(setcar (nthcdr 1 ,info) ,rank))
1952 (defmacro gnus-info-set-read (info read)
1953   `(setcar (nthcdr 2 ,info) ,read))
1954 (defmacro gnus-info-set-marks (info marks &optional extend)
1955   (if extend
1956       `(gnus-info-set-entry ,info ,marks 3)
1957     `(setcar (nthcdr 3 ,info) ,marks)))
1958 (defmacro gnus-info-set-method (info method &optional extend)
1959   (if extend
1960       `(gnus-info-set-entry ,info ,method 4)
1961     `(setcar (nthcdr 4 ,info) ,method)))
1962 (defmacro gnus-info-set-params (info params &optional extend)
1963   (if extend
1964       `(gnus-info-set-entry ,info ,params 5)
1965     `(setcar (nthcdr 5 ,info) ,params)))
1966
1967 (defun gnus-info-set-entry (info entry number)
1968   ;; Extend the info until we have enough elements.
1969   (while (<= (length info) number)
1970     (nconc info (list nil)))
1971   ;; Set the entry.
1972   (setcar (nthcdr number info) entry))
1973
1974 (defmacro gnus-info-set-level (info level)
1975   `(let ((rank (cdr ,info)))
1976      (if (consp (car rank))
1977          (setcar (car rank) ,level)
1978        (setcar rank ,level))))
1979 (defmacro gnus-info-set-score (info score)
1980   `(let ((rank (cdr ,info)))
1981      (if (consp (car rank))
1982          (setcdr (car rank) ,score)
1983        (setcar rank (cons (car rank) ,score)))))
1984
1985 (defmacro gnus-get-info (group)
1986   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
1987
1988 ;; Byte-compiler warning.
1989 (defvar gnus-visual)
1990 ;; Find out whether the gnus-visual TYPE is wanted.
1991 (defun gnus-visual-p (&optional type class)
1992   (and gnus-visual                      ; Has to be non-nil, at least.
1993        (if (not type)                   ; We don't care about type.
1994            gnus-visual
1995          (if (listp gnus-visual)        ; It's a list, so we check it.
1996              (or (memq type gnus-visual)
1997                  (memq class gnus-visual))
1998            t))))
1999
2000 ;;; Load the compatability functions.
2001
2002 (require 'gnus-ems)
2003
2004 \f
2005 ;;;
2006 ;;; Shutdown
2007 ;;;
2008
2009 (defvar gnus-shutdown-alist nil)
2010
2011 (defun gnus-add-shutdown (function &rest symbols)
2012   "Run FUNCTION whenever one of SYMBOLS is shut down."
2013   (push (cons function symbols) gnus-shutdown-alist))
2014
2015 (defun gnus-shutdown (symbol)
2016   "Shut down everything that waits for SYMBOL."
2017   (let ((alist gnus-shutdown-alist)
2018         entry)
2019     (while (setq entry (pop alist))
2020       (when (memq symbol (cdr entry))
2021         (funcall (car entry))))))
2022
2023 \f
2024 ;;;
2025 ;;; Gnus Utility Functions
2026 ;;;
2027
2028
2029 (defmacro gnus-string-or (&rest strings)
2030   "Return the first element of STRINGS that is a non-blank string.
2031 STRINGS will be evaluated in normal `or' order."
2032   `(gnus-string-or-1 ',strings))
2033
2034 (defun gnus-string-or-1 (strings)
2035   (let (string)
2036     (while strings
2037       (setq string (eval (pop strings)))
2038       (if (string-match "^[ \t]*$" string)
2039           (setq string nil)
2040         (setq strings nil)))
2041     string))
2042
2043 (defun gnus-version (&optional arg)
2044   "Version number of this version of Gnus.
2045 If ARG, insert string at point."
2046   (interactive "P")
2047   (if arg
2048       (insert (message gnus-version))
2049     (message gnus-version)))
2050
2051 (defun gnus-continuum-version (version)
2052   "Return VERSION as a floating point number."
2053   (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2054             (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2055     (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2056           (number (match-string 2 version))
2057           major minor least)
2058       (unless (string-match
2059                "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2060         (error "Invalid version string: %s" version))
2061       (setq major (string-to-number (match-string 1 number))
2062             minor (string-to-number (match-string 2 number))
2063             least (if (match-beginning 3)
2064                       (string-to-number (match-string 3 number))
2065                     0))
2066       (string-to-number
2067        (if (zerop major)
2068            (format "%s00%02d%02d"
2069                    (if (member alpha '("(ding)" "d"))
2070                        "4.99"
2071                      (+ 5 (* 0.02
2072                              (abs
2073                               (- (mm-char-int (aref (downcase alpha) 0))
2074                                  (mm-char-int ?t))))
2075                         -0.01))
2076                    minor least)
2077          (format "%d.%02d%02d" major minor least))))))
2078
2079 (defun gnus-info-find-node ()
2080   "Find Info documentation of Gnus."
2081   (interactive)
2082   ;; Enlarge info window if needed.
2083   (let (gnus-info-buffer)
2084     (Info-goto-node (cadr (assq major-mode gnus-info-nodes)))
2085     (setq gnus-info-buffer (current-buffer))
2086     (gnus-configure-windows 'info)))
2087
2088 ;;;
2089 ;;; gnus-interactive
2090 ;;;
2091
2092 (defvar gnus-current-prefix-symbol nil
2093   "Current prefix symbol.")
2094
2095 (defvar gnus-current-prefix-symbols nil
2096   "List of current prefix symbols.")
2097
2098 (defun gnus-interactive (string &optional params)
2099   "Return a list that can be fed to `interactive'.
2100 See `interactive' for full documentation.
2101
2102 Adds the following specs:
2103
2104 y -- The current symbolic prefix.
2105 Y -- A list of the current symbolic prefix(es).
2106 A -- Article number.
2107 H -- Article header.
2108 g -- Group name."
2109   (let ((i 0)
2110         out c prompt)
2111     (while (< i (length string))
2112       (string-match ".\\([^\n]*\\)\n?" string i)
2113       (setq c (aref string i))
2114       (when (match-end 1)
2115         (setq prompt (match-string 1 string)))
2116       (setq i (match-end 0))
2117       ;; We basically emulate just about everything that
2118       ;; `interactive' does, but add the specs listed above.
2119       (push
2120        (cond
2121         ((= c ?a)
2122          (completing-read prompt obarray 'fboundp t))
2123         ((= c ?b)
2124          (read-buffer prompt (current-buffer) t))
2125         ((= c ?B)
2126          (read-buffer prompt (other-buffer (current-buffer))))
2127         ((= c ?c)
2128          (read-char))
2129         ((= c ?C)
2130          (completing-read prompt obarray 'commandp t))
2131         ((= c ?d)
2132          (point))
2133         ((= c ?D)
2134          (read-file-name prompt nil default-directory 'lambda))
2135         ((= c ?f)
2136          (read-file-name prompt nil nil 'lambda))
2137         ((= c ?F)
2138          (read-file-name prompt))
2139         ((= c ?k)
2140          (read-key-sequence prompt))
2141         ((= c ?K)
2142          (error "Not implemented spec"))
2143         ((= c ?e)
2144          (error "Not implemented spec"))
2145         ((= c ?m)
2146          (mark))
2147         ((= c ?N)
2148          (error "Not implemented spec"))
2149         ((= c ?n)
2150          (string-to-number (read-from-minibuffer prompt)))
2151         ((= c ?p)
2152          (prefix-numeric-value current-prefix-arg))
2153         ((= c ?P)
2154          current-prefix-arg)
2155         ((= c ?r)
2156          'gnus-prefix-nil)
2157         ((= c ?s)
2158          (read-string prompt))
2159         ((= c ?S)
2160          (intern (read-string prompt)))
2161         ((= c ?v)
2162          (read-variable prompt))
2163         ((= c ?x)
2164          (read-minibuffer prompt))
2165         ((= c ?x)
2166          (eval-minibuffer prompt))
2167         ;; And here the new specs come.
2168         ((= c ?y)
2169          gnus-current-prefix-symbol)
2170         ((= c ?Y)
2171          gnus-current-prefix-symbols)
2172         ((= c ?g)
2173          (gnus-group-group-name))
2174         ((= c ?A)
2175          (gnus-summary-skip-intangible)
2176          (or (get-text-property (point) 'gnus-number)
2177              (gnus-summary-last-subject)))
2178         ((= c ?H)
2179          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2180         (t
2181          (error "Non-implemented spec")))
2182        out)
2183       (cond
2184        ((= c ?r)
2185         (push (if (< (point) (mark) (point) (mark))) out)
2186         (push (if (> (point) (mark) (point) (mark))) out))))
2187     (setq out (delq 'gnus-prefix-nil out))
2188     (nreverse out)))
2189
2190 (defun gnus-symbolic-argument (&optional arg)
2191   "Read a symbolic argument and a command, and then execute command."
2192   (interactive "P")
2193   (let* ((in-command (this-command-keys))
2194          (command in-command)
2195          gnus-current-prefix-symbols
2196          gnus-current-prefix-symbol
2197          syms)
2198     (while (equal in-command command)
2199       (message "%s-" (key-description (this-command-keys)))
2200       (push (intern (char-to-string (read-char))) syms)
2201       (setq command (read-key-sequence nil t)))
2202     (setq gnus-current-prefix-symbols (nreverse syms)
2203           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2204     (call-interactively (key-binding command t))))
2205
2206 ;;; More various functions.
2207
2208 (defsubst gnus-check-backend-function (func group)
2209   "Check whether GROUP supports function FUNC.
2210 GROUP can either be a string (a group name) or a select method."
2211   (ignore-errors
2212     (let ((method (if (stringp group)
2213                       (car (gnus-find-method-for-group group))
2214                     group)))
2215       (unless (featurep method)
2216         (require method))
2217       (fboundp (intern (format "%s-%s" method func))))))
2218
2219 (defun gnus-group-read-only-p (&optional group)
2220   "Check whether GROUP supports editing or not.
2221 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
2222 that that variable is buffer-local to the summary buffers."
2223   (let ((group (or group gnus-newsgroup-name)))
2224     (not (gnus-check-backend-function 'request-replace-article group))))
2225
2226 (defun gnus-group-total-expirable-p (group)
2227   "Check whether GROUP is total-expirable or not."
2228   (let ((params (gnus-group-find-parameter group))
2229         val)
2230     (cond
2231      ((memq 'total-expire params)
2232       t)
2233      ((setq val (assq 'total-expire params)) ; (auto-expire . t)
2234       (cdr val))
2235      (gnus-total-expirable-newsgroups   ; Check var.
2236       (string-match gnus-total-expirable-newsgroups group)))))
2237
2238 (defun gnus-group-auto-expirable-p (group)
2239   "Check whether GROUP is auto-expirable or not."
2240   (let ((params (gnus-group-find-parameter group))
2241         val)
2242     (cond
2243      ((memq 'auto-expire params)
2244       t)
2245      ((setq val (assq 'auto-expire params)) ; (auto-expire . t)
2246       (cdr val))
2247      (gnus-auto-expirable-newsgroups    ; Check var.
2248       (string-match gnus-auto-expirable-newsgroups group)))))
2249
2250 (defun gnus-virtual-group-p (group)
2251   "Say whether GROUP is virtual or not."
2252   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2253                         gnus-valid-select-methods)))
2254
2255 (defun gnus-news-group-p (group &optional article)
2256   "Return non-nil if GROUP (and ARTICLE) come from a news server."
2257   (or (gnus-member-of-valid 'post group) ; Ordinary news group.
2258       (and (gnus-member-of-valid 'post-mail group) ; Combined group.
2259            (if (or (null article)
2260                    (not (< article 0)))
2261                (eq (gnus-request-type group article) 'news)
2262              (if (not (vectorp article))
2263                  nil
2264                ;; It's a real article.
2265                (eq (gnus-request-type group (mail-header-id article))
2266                    'news))))))
2267
2268 ;; Returns a list of writable groups.
2269 (defun gnus-writable-groups ()
2270   (let ((alist gnus-newsrc-alist)
2271         groups group)
2272     (while (setq group (car (pop alist)))
2273       (unless (gnus-group-read-only-p group)
2274         (push group groups)))
2275     (nreverse groups)))
2276
2277 ;; Check whether to use long file names.
2278 (defun gnus-use-long-file-name (symbol)
2279   ;; The variable has to be set...
2280   (and gnus-use-long-file-name
2281        ;; If it isn't a list, then we return t.
2282        (or (not (listp gnus-use-long-file-name))
2283            ;; If it is a list, and the list contains `symbol', we
2284            ;; return nil.
2285            (not (memq symbol gnus-use-long-file-name)))))
2286
2287 ;; Generate a unique new group name.
2288 (defun gnus-generate-new-group-name (leaf)
2289   (let ((name leaf)
2290         (num 0))
2291     (while (gnus-gethash name gnus-newsrc-hashtb)
2292       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2293     name))
2294
2295 (defun gnus-ephemeral-group-p (group)
2296   "Say whether GROUP is ephemeral or not."
2297   (gnus-group-get-parameter group 'quit-config t))
2298
2299 (defun gnus-group-quit-config (group)
2300   "Return the quit-config of GROUP."
2301   (gnus-group-get-parameter group 'quit-config t))
2302
2303 (defun gnus-kill-ephemeral-group (group)
2304   "Remove ephemeral GROUP from relevant structures."
2305   (gnus-sethash group nil gnus-newsrc-hashtb))
2306
2307 (defun gnus-simplify-mode-line ()
2308   "Make mode lines a bit simpler."
2309   (setq mode-line-modified (cdr gnus-mode-line-modified))
2310   (when (listp mode-line-format)
2311     (make-local-variable 'mode-line-format)
2312     (setq mode-line-format (copy-sequence mode-line-format))
2313     (when (equal (nth 3 mode-line-format) "   ")
2314       (setcar (nthcdr 3 mode-line-format) " "))))
2315
2316 ;;; Servers and groups.
2317
2318 (defsubst gnus-server-add-address (method)
2319   (let ((method-name (symbol-name (car method))))
2320     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2321              (not (assq (intern (concat method-name "-address")) method))
2322              (memq 'physical-address (assq (car method)
2323                                            gnus-valid-select-methods)))
2324         (append method (list (list (intern (concat method-name "-address"))
2325                                    (nth 1 method))))
2326       method)))
2327
2328 (defsubst gnus-server-get-method (group method)
2329   ;; Input either a server name, and extended server name, or a
2330   ;; select method, and return a select method.
2331   (cond ((stringp method)
2332          (gnus-server-to-method method))
2333         ((equal method gnus-select-method)
2334          gnus-select-method)
2335         ((and (stringp (car method))
2336               group)
2337          (gnus-server-extend-method group method))
2338         ((and method
2339               (not group)
2340               (equal (cadr method) ""))
2341          method)
2342         (t
2343          (gnus-server-add-address method))))
2344
2345 (defun gnus-server-to-method (server)
2346   "Map virtual server names to select methods."
2347   (or
2348    ;; Is this a method, perhaps?
2349    (and server (listp server) server)
2350    ;; Perhaps this is the native server?
2351    (and (equal server "native") gnus-select-method)
2352    ;; It should be in the server alist.
2353    (cdr (assoc server gnus-server-alist))
2354    ;; It could be in the predefined server alist.
2355    (cdr (assoc server gnus-predefined-server-alist))
2356    ;; If not, we look through all the opened server
2357    ;; to see whether we can find it there.
2358    (let ((opened gnus-opened-servers))
2359      (while (and opened
2360                  (not (equal server (format "%s:%s" (caaar opened)
2361                                             (cadaar opened)))))
2362        (pop opened))
2363      (caar opened))
2364    ;; It could be a named method, search all servers
2365    (let ((servers gnus-secondary-select-methods))
2366      (while (and servers
2367                  (not (equal server (format "%s:%s" (caar servers)
2368                                             (cadar servers)))))
2369        (pop servers))
2370      (car servers))))
2371
2372 (defmacro gnus-method-equal (ss1 ss2)
2373   "Say whether two servers are equal."
2374   `(let ((s1 ,ss1)
2375          (s2 ,ss2))
2376      (or (equal s1 s2)
2377          (and (= (length s1) (length s2))
2378               (progn
2379                 (while (and s1 (member (car s1) s2))
2380                   (setq s1 (cdr s1)))
2381                 (null s1))))))
2382
2383 (defun gnus-server-equal (m1 m2)
2384   "Say whether two methods are equal."
2385   (let ((m1 (cond ((null m1) gnus-select-method)
2386                   ((stringp m1) (gnus-server-to-method m1))
2387                   (t m1)))
2388         (m2 (cond ((null m2) gnus-select-method)
2389                   ((stringp m2) (gnus-server-to-method m2))
2390                   (t m2))))
2391     (gnus-method-equal m1 m2)))
2392
2393 (defun gnus-servers-using-backend (backend)
2394   "Return a list of known servers using BACKEND."
2395   (let ((opened gnus-opened-servers)
2396         out)
2397     (while opened
2398       (when (eq backend (caaar opened))
2399         (push (caar opened) out))
2400       (pop opened))
2401     out))
2402
2403 (defun gnus-archive-server-wanted-p ()
2404   "Say whether the user wants to use the archive server."
2405   (cond
2406    ((or (not gnus-message-archive-method)
2407         (not gnus-message-archive-group))
2408     nil)
2409    ((and gnus-message-archive-method gnus-message-archive-group)
2410     t)
2411    (t
2412     (let ((active (cadr (assq 'nnfolder-active-file
2413                               gnus-message-archive-method))))
2414       (and active
2415            (file-exists-p active))))))
2416
2417 (defun gnus-group-prefixed-name (group method)
2418   "Return the whole name from GROUP and METHOD."
2419   (and (stringp method) (setq method (gnus-server-to-method method)))
2420   (if (or (not method)
2421           (gnus-server-equal method "native"))
2422       group
2423     (concat (format "%s" (car method))
2424             (when (and
2425                    (or (assoc (format "%s" (car method))
2426                               (gnus-methods-using 'address))
2427                        (gnus-server-equal method gnus-message-archive-method))
2428                    (nth 1 method)
2429                    (not (string= (nth 1 method) "")))
2430               (concat "+" (nth 1 method)))
2431             ":" group)))
2432
2433 (defun gnus-group-real-prefix (group)
2434   "Return the prefix of the current group name."
2435   (if (string-match "^[^:]+:" group)
2436       (substring group 0 (match-end 0))
2437     ""))
2438
2439 (defun gnus-group-method (group)
2440   "Return the server or method used for selecting GROUP.
2441 You should probably use `gnus-find-method-for-group' instead."
2442   (let ((prefix (gnus-group-real-prefix group)))
2443     (if (equal prefix "")
2444         gnus-select-method
2445       (let ((servers gnus-opened-servers)
2446             (server "")
2447             backend possible found)
2448         (if (string-match "^[^\\+]+\\+" prefix)
2449             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2450                   server (substring prefix (match-end 0) (1- (length prefix))))
2451           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2452         (while servers
2453           (when (eq (caaar servers) backend)
2454             (setq possible (caar servers))
2455             (when (equal (cadaar servers) server)
2456               (setq found (caar servers))))
2457           (pop servers))
2458         (or (car (rassoc found gnus-server-alist))
2459             found
2460             (car (rassoc possible gnus-server-alist))
2461             possible
2462             (list backend server))))))
2463
2464 (defsubst gnus-native-method-p (method)
2465   "Return whether METHOD is the native select method."
2466   (gnus-method-equal method gnus-select-method))
2467
2468 (defsubst gnus-secondary-method-p (method)
2469   "Return whether METHOD is a secondary select method."
2470   (let ((methods gnus-secondary-select-methods)
2471         (gmethod (gnus-server-get-method nil method)))
2472     (while (and methods
2473                (not (gnus-method-equal
2474                      (gnus-server-get-method nil (car methods))
2475                      gmethod)))
2476       (setq methods (cdr methods)))
2477     methods))
2478
2479 (defun gnus-method-simplify (method)
2480   "Return the shortest uniquely identifying string or method for METHOD."
2481   (cond ((gnus-native-method-p method)
2482         nil)
2483        ((gnus-secondary-method-p method)
2484         (format "%s:%s" (nth 0 method) (nth 1 method)))
2485        (t
2486         method)))
2487
2488 (defun gnus-groups-from-server (server)
2489   "Return a list of all groups that are fetched from SERVER."
2490   (let ((alist (cdr gnus-newsrc-alist))
2491         info groups)
2492     (while (setq info (pop alist))
2493       (when (gnus-server-equal (gnus-info-method info) server)
2494         (push (gnus-info-group info) groups)))
2495     (sort groups 'string<)))
2496
2497 (defun gnus-group-foreign-p (group)
2498   "Say whether a group is foreign or not."
2499   (and (not (gnus-group-native-p group))
2500        (not (gnus-group-secondary-p group))))
2501
2502 (defun gnus-group-native-p (group)
2503   "Say whether the group is native or not."
2504   (not (string-match ":" group)))
2505
2506 (defun gnus-group-secondary-p (group)
2507   "Say whether the group is secondary or not."
2508   (gnus-secondary-method-p (gnus-find-method-for-group group)))
2509
2510 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2511   "Return the group parameters for GROUP.
2512 If SYMBOL, return the value of that symbol in the group parameters."
2513   (save-excursion
2514     (set-buffer gnus-group-buffer)
2515     (let ((parameters (funcall gnus-group-get-parameter-function group)))
2516       (if symbol
2517           (gnus-group-parameter-value parameters symbol allow-list)
2518         parameters))))
2519
2520 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2521   "Return the group parameters for GROUP.
2522 If SYMBOL, return the value of that symbol in the group parameters.
2523 Most functions should use `gnus-group-find-parameter', which
2524 also examines the topic parameters."
2525   (let ((params (gnus-info-params (gnus-get-info group))))
2526     (if symbol
2527         (gnus-group-parameter-value params symbol allow-list)
2528       params)))
2529
2530 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2531   "Return the value of SYMBOL in group PARAMS."
2532   ;; We only wish to return group parameters (dotted lists) and
2533   ;; not local variables, which may have the same names.
2534   ;; But first we handle single elements...
2535   (or (car (memq symbol params))
2536       ;; Handle alist.
2537       (let (elem)
2538         (catch 'found
2539           (while (setq elem (pop params))
2540             (when (and (consp elem)
2541                        (eq (car elem) symbol)
2542                        (or allow-list
2543                            (atom (cdr elem))))
2544               (throw 'found (cdr elem))))))))
2545
2546 (defun gnus-group-add-parameter (group param)
2547   "Add parameter PARAM to GROUP."
2548   (let ((info (gnus-get-info group)))
2549     (when info
2550       (gnus-group-remove-parameter group (if (consp param) (car param) param))
2551       ;; Cons the new param to the old one and update.
2552       (gnus-group-set-info (cons param (gnus-info-params info))
2553                            group 'params))))
2554
2555 (defun gnus-group-set-parameter (group name value)
2556   "Set parameter NAME to VALUE in GROUP."
2557   (let ((info (gnus-get-info group)))
2558     (when info
2559       (gnus-group-remove-parameter group name)
2560       (let ((old-params (gnus-info-params info))
2561             (new-params (list (cons name value))))
2562         (while old-params
2563           (when (or (not (listp (car old-params)))
2564                     (not (eq (caar old-params) name)))
2565             (setq new-params (append new-params (list (car old-params)))))
2566           (setq old-params (cdr old-params)))
2567         (gnus-group-set-info new-params group 'params)))))
2568
2569 (defun gnus-group-remove-parameter (group name)
2570   "Remove parameter NAME from GROUP."
2571   (let ((info (gnus-get-info group)))
2572     (when info
2573       (let ((params (gnus-info-params info)))
2574         (when params
2575           (setq params (delq name params))
2576           (while (assq name params)
2577             (gnus-pull name params))
2578           (gnus-info-set-params info params))))))
2579
2580 (defun gnus-group-add-score (group &optional score)
2581   "Add SCORE to the GROUP score.
2582 If SCORE is nil, add 1 to the score of GROUP."
2583   (let ((info (gnus-get-info group)))
2584     (when info
2585       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
2586
2587 ;; Function written by Stainless Steel Rat <ratinox@peorth.gweep.net>
2588 (defun gnus-short-group-name (group &optional levels)
2589   "Collapse GROUP name LEVELS.
2590 Select methods are stripped and any remote host name is stripped down to
2591 just the host name."
2592   (let* ((name "")
2593          (foreign "")
2594          (depth 0)
2595          (skip 1)
2596          (levels (or levels
2597                      (progn
2598                        (while (string-match "\\." group skip)
2599                          (setq skip (match-end 0)
2600                                depth (+ depth 1)))
2601                        depth))))
2602     ;; separate foreign select method from group name and collapse.
2603     ;; if method contains a server, collapse to non-domain server name,
2604     ;; otherwise collapse to select method
2605     (let* ((colon  (string-match ":" group))
2606            (server (and colon (substring group 0 colon)))
2607            (plus   (and server (string-match "+" server))))
2608       (when server
2609         (cond (plus
2610                (setq foreign (substring server (+ 1 plus)
2611                                         (string-match "\\." server))
2612                      group (substring group (+ 1 colon))))
2613                (t
2614                 (setq foreign server
2615                       group (substring group (+ 1 colon)))))
2616         (setq foreign (concat foreign ":"))))
2617     ;; collapse group name leaving LEVELS uncollapsed elements
2618     (while group
2619       (if (and (string-match "\\." group) (> levels 0))
2620           (setq name (concat name (substring group 0 1))
2621                 group (substring group (match-end 0))
2622                 levels (- levels 1)
2623                 name (concat name "."))
2624         (setq name (concat foreign name group)
2625               group nil)))
2626     name))
2627
2628 (defun gnus-narrow-to-body ()
2629   "Narrow to the body of an article."
2630   (narrow-to-region
2631    (progn
2632      (goto-char (point-min))
2633      (or (search-forward "\n\n" nil t)
2634          (point-max)))
2635    (point-max)))
2636
2637 \f
2638 ;;;
2639 ;;; Kill file handling.
2640 ;;;
2641
2642 (defun gnus-apply-kill-file ()
2643   "Apply a kill file to the current newsgroup.
2644 Returns the number of articles marked as read."
2645   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
2646           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2647       (gnus-apply-kill-file-internal)
2648     0))
2649
2650 (defun gnus-kill-save-kill-buffer ()
2651   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
2652     (when (get-file-buffer file)
2653       (save-excursion
2654         (set-buffer (get-file-buffer file))
2655         (when (buffer-modified-p)
2656           (save-buffer))
2657         (kill-buffer (current-buffer))))))
2658
2659 (defcustom gnus-kill-file-name "KILL"
2660   "Suffix of the kill files."
2661   :group 'gnus-score-kill
2662   :group 'gnus-score-files
2663   :type 'string)
2664
2665 (defun gnus-newsgroup-kill-file (newsgroup)
2666   "Return the name of a kill file name for NEWSGROUP.
2667 If NEWSGROUP is nil, return the global kill file name instead."
2668   (cond
2669    ;; The global KILL file is placed at top of the directory.
2670    ((or (null newsgroup)
2671         (string-equal newsgroup ""))
2672     (expand-file-name gnus-kill-file-name
2673                       gnus-kill-files-directory))
2674    ;; Append ".KILL" to newsgroup name.
2675    ((gnus-use-long-file-name 'not-kill)
2676     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
2677                               "." gnus-kill-file-name)
2678                       gnus-kill-files-directory))
2679    ;; Place "KILL" under the hierarchical directory.
2680    (t
2681     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
2682                               "/" gnus-kill-file-name)
2683                       gnus-kill-files-directory))))
2684
2685 ;;; Server things.
2686
2687 (defun gnus-member-of-valid (symbol group)
2688   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
2689   (memq symbol (assoc
2690                 (symbol-name (car (gnus-find-method-for-group group)))
2691                 gnus-valid-select-methods)))
2692
2693 (defun gnus-method-option-p (method option)
2694   "Return non-nil if select METHOD has OPTION as a parameter."
2695   (when (stringp method)
2696     (setq method (gnus-server-to-method method)))
2697   (memq option (assoc (format "%s" (car method))
2698                       gnus-valid-select-methods)))
2699
2700 (defun gnus-similar-server-opened (method)
2701   (let ((opened gnus-opened-servers))
2702     (while (and method opened)
2703       (when (and (equal (cadr method) (cadaar opened))
2704                 (equal (car method) (caaar opened))
2705                  (not (equal method (caar opened))))
2706         (setq method nil))
2707       (pop opened))
2708     (not method)))
2709
2710 (defun gnus-server-extend-method (group method)
2711   ;; This function "extends" a virtual server.  If the server is
2712   ;; "hello", and the select method is ("hello" (my-var "something"))
2713   ;; in the group "alt.alt", this will result in a new virtual server
2714   ;; called "hello+alt.alt".
2715   (if (or (not (inline (gnus-similar-server-opened method)))
2716           (not (cddr method)))
2717       method
2718     `(,(car method) ,(concat (cadr method) "+" group)
2719       (,(intern (format "%s-address" (car method))) ,(cadr method))
2720       ,@(cddr method))))
2721
2722 (defun gnus-server-status (method)
2723   "Return the status of METHOD."
2724   (nth 1 (assoc method gnus-opened-servers)))
2725
2726 (defun gnus-group-name-to-method (group)
2727   "Guess a select method based on GROUP."
2728   (if (string-match ":" group)
2729       (let ((server (substring group 0 (match-beginning 0))))
2730         (if (string-match "\\+" server)
2731             (list (intern (substring server 0 (match-beginning 0)))
2732                   (substring server (match-end 0)))
2733           (list (intern server) "")))
2734     gnus-select-method))
2735
2736 (defun gnus-find-method-for-group (group &optional info)
2737   "Find the select method that GROUP uses."
2738   (or gnus-override-method
2739       (and (not group)
2740            gnus-select-method)
2741       (let ((info (or info (gnus-get-info group)))
2742             method)
2743         (if (or (not info)
2744                 (not (setq method (gnus-info-method info)))
2745                 (equal method "native"))
2746             gnus-select-method
2747           (setq method
2748                 (cond ((stringp method)
2749                        (inline (gnus-server-to-method method)))
2750                       ((stringp (cadr method))
2751                        (inline (gnus-server-extend-method group method)))
2752                       (t
2753                        method)))
2754           (cond ((equal (cadr method) "")
2755                  method)
2756                 ((null (cadr method))
2757                  (list (car method) ""))
2758                 (t
2759                  (gnus-server-add-address method)))))))
2760
2761 (defun gnus-methods-using (feature)
2762   "Find all methods that have FEATURE."
2763   (let ((valids gnus-valid-select-methods)
2764         outs)
2765     (while valids
2766       (when (memq feature (car valids))
2767         (push (car valids) outs))
2768       (setq valids (cdr valids)))
2769     outs))
2770
2771 (defun gnus-read-group (prompt &optional default)
2772   "Prompt the user for a group name.
2773 Disallow illegal group names."
2774   (let ((prefix "")
2775         group)
2776     (while (not group)
2777       (when (string-match
2778              "[: `'\"/]\\|^$"
2779              (setq group (read-string (concat prefix prompt)
2780                                       (cons (or default "") 0)
2781                                       'gnus-group-history)))
2782         (setq prefix (format "Illegal group name: \"%s\".  " group)
2783               group nil)))
2784     group))
2785
2786 (defun gnus-read-method (prompt)
2787   "Prompt the user for a method.
2788 Allow completion over sensible values."
2789   (let* ((servers
2790           (append gnus-valid-select-methods
2791                   gnus-predefined-server-alist
2792                   gnus-server-alist))
2793          (method
2794           (completing-read
2795            prompt servers
2796            nil t nil 'gnus-method-history)))
2797     (cond
2798      ((equal method "")
2799       (setq method gnus-select-method))
2800      ((assoc method gnus-valid-select-methods)
2801       (list (intern method)
2802             (if (memq 'prompt-address
2803                       (assoc method gnus-valid-select-methods))
2804                 (read-string "Address: ")
2805               "")))
2806      ((assoc method servers)
2807       method)
2808      (t
2809       (list (intern method) "")))))
2810
2811 ;;; User-level commands.
2812
2813 ;;;###autoload
2814 (defun gnus-slave-no-server (&optional arg)
2815   "Read network news as a slave, without connecting to local server."
2816   (interactive "P")
2817   (gnus-no-server arg t))
2818
2819 ;;;###autoload
2820 (defun gnus-no-server (&optional arg slave)
2821   "Read network news.
2822 If ARG is a positive number, Gnus will use that as the
2823 startup level.  If ARG is nil, Gnus will be started at level 2.
2824 If ARG is non-nil and not a positive number, Gnus will
2825 prompt the user for the name of an NNTP server to use.
2826 As opposed to `gnus', this command will not connect to the local server."
2827   (interactive "P")
2828   (gnus-no-server-1 arg slave))
2829
2830 ;;;###autoload
2831 (defun gnus-slave (&optional arg)
2832   "Read news as a slave."
2833   (interactive "P")
2834   (gnus arg nil 'slave))
2835
2836 ;;;###autoload
2837 (defun gnus-other-frame (&optional arg)
2838   "Pop up a frame to read news."
2839   (interactive "P")
2840   (let ((window (get-buffer-window gnus-group-buffer)))
2841     (cond (window
2842            (select-frame (window-frame window)))
2843           ((= (length (frame-list)) 1)
2844            (select-frame (make-frame)))
2845           (t
2846            (other-frame 1))))
2847   (gnus arg))
2848
2849 ;;;###autoload
2850 (defun gnus (&optional arg dont-connect slave)
2851   "Read network news.
2852 If ARG is non-nil and a positive number, Gnus will use that as the
2853 startup level.  If ARG is non-nil and not a positive number, Gnus will
2854 prompt the user for the name of an NNTP server to use."
2855   (interactive "P")
2856   (gnus-1 arg dont-connect slave))
2857
2858 ;; Allow redefinition of Gnus functions.
2859
2860 (gnus-ems-redefine)
2861
2862 (provide 'gnus)
2863
2864 ;;; gnus.el ends here