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

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