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