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