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

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