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

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