cgit.sxemacs.org Git - gnus/blob - lisp/gnus.el

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