git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus.el

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