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

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