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

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