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