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

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