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

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