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

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