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

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