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