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