Synch to No Gnus 200401230349.
[elisp/gnus.git-] / lisp / gnus.el
1 ;;; gnus.el --- a newsreader for GNU Emacs
2
3 ;; Copyright (C) 1987, 1988, 1989, 1990, 1993, 1994, 1995, 1996, 1997,
4 ;; 1998, 2000, 2001, 2002, 2003, 2004 Free Software Foundation, Inc.
5
6 ;; Author: Masanobu UMEDA <umerin@flab.flab.fujitsu.junet>
7 ;;      Lars Magne Ingebrigtsen <larsi@gnus.org>
8 ;;      Tatsuya Ichikawa <t-ichi@po.shiojiri.ne.jp>
9 ;;      Yoshiki Hayashi <t90553@mail.ecc.u-tokyo.ac.jp>
10 ;; Keywords: news, mail
11
12 ;; This file is part of GNU Emacs.
13
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; any later version.
18
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22 ;; GNU General Public License for more details.
23
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
28
29 ;;; Commentary:
30
31 ;;; Code:
32
33 (eval '(run-hooks 'gnus-load-hook))
34
35 (eval-when-compile (require 'cl))
36 (eval-when-compile (require 'static))
37
38 (require 'wid-edit)
39 (require 'nnheader)
40
41 (require 'gnus-vers)
42
43 (defgroup gnus nil
44   "The coffee-brewing, all singing, all dancing, kitchen sink newsreader."
45   :group 'news
46   :group 'mail)
47
48 (defgroup gnus-format nil
49   "Dealing with formatting issues."
50   :group 'gnus)
51
52 (defgroup gnus-charset nil
53   "Group character set issues."
54   :link '(custom-manual "(gnus)Charsets")
55   :version "21.1"
56   :group 'gnus)
57
58 (defgroup gnus-cache nil
59   "Cache interface."
60   :link '(custom-manual "(gnus)Article Caching")
61   :group 'gnus)
62
63 (defgroup gnus-registry nil
64   "Article Registry."
65   :group 'gnus)
66
67 (defgroup gnus-start nil
68   "Starting your favorite newsreader."
69   :group 'gnus)
70
71 (defgroup gnus-start-server nil
72   "Server options at startup."
73   :group 'gnus-start)
74
75 ;; These belong to gnus-group.el.
76 (defgroup gnus-group nil
77   "Group buffers."
78   :link '(custom-manual "(gnus)The Group Buffer")
79   :group 'gnus)
80
81 (defgroup gnus-group-foreign nil
82   "Foreign groups."
83   :link '(custom-manual "(gnus)Foreign Groups")
84   :group 'gnus-group)
85
86 (defgroup gnus-group-new nil
87   "Automatic subscription of new groups."
88   :group 'gnus-group)
89
90 (defgroup gnus-group-levels nil
91   "Group levels."
92   :link '(custom-manual "(gnus)Group Levels")
93   :group 'gnus-group)
94
95 (defgroup gnus-group-select nil
96   "Selecting a Group."
97   :link '(custom-manual "(gnus)Selecting a Group")
98   :group 'gnus-group)
99
100 (defgroup gnus-group-listing nil
101   "Showing slices of the group list."
102   :link '(custom-manual "(gnus)Listing Groups")
103   :group 'gnus-group)
104
105 (defgroup gnus-group-visual nil
106   "Sorting the group buffer."
107   :link '(custom-manual "(gnus)Group Buffer Format")
108   :group 'gnus-group
109   :group 'gnus-visual)
110
111 (defgroup gnus-group-various nil
112   "Various group options."
113   :link '(custom-manual "(gnus)Scanning New Messages")
114   :group 'gnus-group)
115
116 ;; These belong to gnus-sum.el.
117 (defgroup gnus-summary nil
118   "Summary buffers."
119   :link '(custom-manual "(gnus)The Summary Buffer")
120   :group 'gnus)
121
122 (defgroup gnus-summary-exit nil
123   "Leaving summary buffers."
124   :link '(custom-manual "(gnus)Exiting the Summary Buffer")
125   :group 'gnus-summary)
126
127 (defgroup gnus-summary-marks nil
128   "Marks used in summary buffers."
129   :link '(custom-manual "(gnus)Marking Articles")
130   :group 'gnus-summary)
131
132 (defgroup gnus-thread nil
133   "Ordering articles according to replies."
134   :link '(custom-manual "(gnus)Threading")
135   :group 'gnus-summary)
136
137 (defgroup gnus-summary-format nil
138   "Formatting of the summary buffer."
139   :link '(custom-manual "(gnus)Summary Buffer Format")
140   :group 'gnus-summary)
141
142 (defgroup gnus-summary-choose nil
143   "Choosing Articles."
144   :link '(custom-manual "(gnus)Choosing Articles")
145   :group 'gnus-summary)
146
147 (defgroup gnus-summary-maneuvering nil
148   "Summary movement commands."
149   :link '(custom-manual "(gnus)Summary Maneuvering")
150   :group 'gnus-summary)
151
152 (defgroup gnus-picon nil
153   "Show pictures of people, domains, and newsgroups."
154   :group 'gnus-visual)
155
156 (defgroup gnus-summary-mail nil
157   "Mail group commands."
158   :link '(custom-manual "(gnus)Mail Group Commands")
159   :group 'gnus-summary)
160
161 (defgroup gnus-summary-sort nil
162   "Sorting the summary buffer."
163   :link '(custom-manual "(gnus)Sorting")
164   :group 'gnus-summary)
165
166 (defgroup gnus-summary-visual nil
167   "Highlighting and menus in the summary buffer."
168   :link '(custom-manual "(gnus)Summary Highlighting")
169   :group 'gnus-visual
170   :group 'gnus-summary)
171
172 (defgroup gnus-summary-various nil
173   "Various summary buffer options."
174   :link '(custom-manual "(gnus)Various Summary Stuff")
175   :group 'gnus-summary)
176
177 (defgroup gnus-summary-pick nil
178   "Pick mode in the summary buffer."
179   :link '(custom-manual "(gnus)Pick and Read")
180   :prefix "gnus-pick-"
181   :group 'gnus-summary)
182
183 (defgroup gnus-summary-tree nil
184   "Tree display of threads in the summary buffer."
185   :link '(custom-manual "(gnus)Tree Display")
186   :prefix "gnus-tree-"
187   :group 'gnus-summary)
188
189 ;; Belongs to gnus-uu.el
190 (defgroup gnus-extract-view nil
191   "Viewing extracted files."
192   :link '(custom-manual "(gnus)Viewing Files")
193   :group 'gnus-extract)
194
195 ;; Belongs to gnus-score.el
196 (defgroup gnus-score nil
197   "Score and kill file handling."
198   :group 'gnus)
199
200 (defgroup gnus-score-kill nil
201   "Kill files."
202   :group 'gnus-score)
203
204 (defgroup gnus-score-adapt nil
205   "Adaptive score files."
206   :group 'gnus-score)
207
208 (defgroup gnus-score-default nil
209   "Default values for score files."
210   :group 'gnus-score)
211
212 (defgroup gnus-score-expire nil
213   "Expiring score rules."
214   :group 'gnus-score)
215
216 (defgroup gnus-score-decay nil
217   "Decaying score rules."
218   :group 'gnus-score)
219
220 (defgroup gnus-score-files nil
221   "Score and kill file names."
222   :group 'gnus-score
223   :group 'gnus-files)
224
225 (defgroup gnus-score-various nil
226   "Various scoring and killing options."
227   :group 'gnus-score)
228
229 ;; Other
230 (defgroup gnus-visual nil
231   "Options controlling the visual fluff."
232   :group 'gnus
233   :group 'faces)
234
235 (defgroup gnus-agent nil
236   "Offline support for Gnus."
237   :group 'gnus)
238
239 (defgroup gnus-files nil
240   "Files used by Gnus."
241   :group 'gnus)
242
243 (defgroup gnus-dribble-file nil
244   "Auto save file."
245   :link '(custom-manual "(gnus)Auto Save")
246   :group 'gnus-files)
247
248 (defgroup gnus-newsrc nil
249   "Storing Gnus state."
250   :group 'gnus-files)
251
252 (defgroup gnus-server nil
253   "Options related to newsservers and other servers used by Gnus."
254   :group 'gnus)
255
256 (defgroup gnus-server-visual nil
257   "Highlighting and menus in the server buffer."
258   :group 'gnus-visual
259   :group 'gnus-server)
260
261 (defgroup gnus-message '((message custom-group))
262   "Composing replies and followups in Gnus."
263   :group 'gnus)
264
265 (defgroup gnus-meta nil
266   "Meta variables controlling major portions of Gnus.
267 In general, modifying these variables does not take affect until Gnus
268 is restarted, and sometimes reloaded."
269   :group 'gnus)
270
271 (defgroup gnus-various nil
272   "Other Gnus options."
273   :link '(custom-manual "(gnus)Various Various")
274   :group 'gnus)
275
276 (defgroup gnus-mime nil
277   "Variables for controlling the Gnus MIME interface."
278   :group 'gnus)
279
280 (defgroup gnus-exit nil
281   "Exiting gnus."
282   :link '(custom-manual "(gnus)Exiting Gnus")
283   :group 'gnus)
284
285 (defgroup gnus-fun nil
286   "Frivolous Gnus extensions."
287   :link '(custom-manual "(gnus)Exiting Gnus")
288   :group 'gnus)
289
290 (defcustom gnus-inhibit-startup-message nil
291   "If non-nil, the startup message will not be displayed.
292 This variable is used before `.gnus.el' is loaded, so it should
293 be set in `.emacs' instead."
294   :group 'gnus-start
295   :type 'boolean)
296
297 (defcustom gnus-play-startup-jingle nil
298   "If non-nil, play the Gnus jingle at startup."
299   :group 'gnus-start
300   :type 'boolean)
301
302 (unless (fboundp 'gnus-group-remove-excess-properties)
303   (defalias 'gnus-group-remove-excess-properties 'ignore))
304
305 (unless (featurep 'gnus-xmas)
306   (defalias 'gnus-make-overlay 'make-overlay)
307   (defalias 'gnus-delete-overlay 'delete-overlay)
308   (defalias 'gnus-overlay-put 'overlay-put)
309   (defalias 'gnus-move-overlay 'move-overlay)
310   (defalias 'gnus-overlay-buffer 'overlay-buffer)
311   (defalias 'gnus-overlay-start 'overlay-start)
312   (defalias 'gnus-overlay-end 'overlay-end)
313   (defalias 'gnus-extent-detached-p 'ignore)
314   (defalias 'gnus-extent-start-open 'ignore)
315   (defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
316   (defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
317   (defalias 'gnus-character-to-event 'identity)
318   (defalias 'gnus-assq-delete-all 'assq-delete-all)
319   (defalias 'gnus-add-text-properties 'add-text-properties)
320   (defalias 'gnus-put-text-property 'put-text-property)
321   (defvar gnus-mode-line-image-cache t)
322   (if (fboundp 'find-image)
323       (defun gnus-mode-line-buffer-identification (line)
324         (let ((str (car-safe line)))
325           (if (and (stringp str)
326                    (string-match "^Gnus:" str))
327               (progn (add-text-properties
328                       0 5
329                       (list 'display
330                             (if (eq t gnus-mode-line-image-cache)
331                                 (setq gnus-mode-line-image-cache
332                                       (find-image
333                                        '((:type xpm :file "gnus-pointer.xpm"
334                                                 :ascent center)
335                                          (:type xbm :file "gnus-pointer.xbm"
336                                                 :ascent center))))
337                               gnus-mode-line-image-cache)
338                             'help-echo (format
339                                         "This is %s, %s."
340                                         gnus-version (gnus-emacs-version)))
341                       str)
342                      (list str))
343             line)))
344     (defalias 'gnus-mode-line-buffer-identification 'identity))
345   (defalias 'gnus-characterp 'numberp)
346   (defalias 'gnus-deactivate-mark 'deactivate-mark)
347   (defalias 'gnus-window-edges 'window-edges)
348   (defalias 'gnus-key-press-event-p 'numberp)
349   ;;(defalias 'gnus-decode-rfc1522 'ignore)
350   )
351
352 ;; We define these group faces here to avoid the display
353 ;; update forced when creating new faces.
354
355 (defface gnus-group-news-1-face
356   '((((class color)
357       (background dark))
358      (:foreground "PaleTurquoise" :bold t))
359     (((class color)
360       (background light))
361      (:foreground "ForestGreen" :bold t))
362     (t
363      ()))
364   "Level 1 newsgroup face.")
365
366 (defface gnus-group-news-1-empty-face
367   '((((class color)
368       (background dark))
369      (:foreground "PaleTurquoise"))
370     (((class color)
371       (background light))
372      (:foreground "ForestGreen"))
373     (t
374      ()))
375   "Level 1 empty newsgroup face.")
376
377 (defface gnus-group-news-2-face
378   '((((class color)
379       (background dark))
380      (:foreground "turquoise" :bold t))
381     (((class color)
382       (background light))
383      (:foreground "CadetBlue4" :bold t))
384     (t
385      ()))
386   "Level 2 newsgroup face.")
387
388 (defface gnus-group-news-2-empty-face
389   '((((class color)
390       (background dark))
391      (:foreground "turquoise"))
392     (((class color)
393       (background light))
394      (:foreground "CadetBlue4"))
395     (t
396      ()))
397   "Level 2 empty newsgroup face.")
398
399 (defface gnus-group-news-3-face
400   '((((class color)
401       (background dark))
402      (:bold t))
403     (((class color)
404       (background light))
405      (:bold t))
406     (t
407      ()))
408   "Level 3 newsgroup face.")
409
410 (defface gnus-group-news-3-empty-face
411   '((((class color)
412       (background dark))
413      ())
414     (((class color)
415       (background light))
416      ())
417     (t
418      ()))
419   "Level 3 empty newsgroup face.")
420
421 (defface gnus-group-news-4-face
422   '((((class color)
423       (background dark))
424      (:bold t))
425     (((class color)
426       (background light))
427      (:bold t))
428     (t
429      ()))
430   "Level 4 newsgroup face.")
431
432 (defface gnus-group-news-4-empty-face
433   '((((class color)
434       (background dark))
435      ())
436     (((class color)
437       (background light))
438      ())
439     (t
440      ()))
441   "Level 4 empty newsgroup face.")
442
443 (defface gnus-group-news-5-face
444   '((((class color)
445       (background dark))
446      (:bold t))
447     (((class color)
448       (background light))
449      (:bold t))
450     (t
451      ()))
452   "Level 5 newsgroup face.")
453
454 (defface gnus-group-news-5-empty-face
455   '((((class color)
456       (background dark))
457      ())
458     (((class color)
459       (background light))
460      ())
461     (t
462      ()))
463   "Level 5 empty newsgroup face.")
464
465 (defface gnus-group-news-6-face
466   '((((class color)
467       (background dark))
468      (:bold t))
469     (((class color)
470       (background light))
471      (:bold t))
472     (t
473      ()))
474   "Level 6 newsgroup face.")
475
476 (defface gnus-group-news-6-empty-face
477   '((((class color)
478       (background dark))
479      ())
480     (((class color)
481       (background light))
482      ())
483     (t
484      ()))
485   "Level 6 empty newsgroup face.")
486
487 (defface gnus-group-news-low-face
488   '((((class color)
489       (background dark))
490      (:foreground "DarkTurquoise" :bold t))
491     (((class color)
492       (background light))
493      (:foreground "DarkGreen" :bold t))
494     (t
495      ()))
496   "Low level newsgroup face.")
497
498 (defface gnus-group-news-low-empty-face
499   '((((class color)
500       (background dark))
501      (:foreground "DarkTurquoise"))
502     (((class color)
503       (background light))
504      (:foreground "DarkGreen"))
505     (t
506      ()))
507   "Low level empty newsgroup face.")
508
509 (defface gnus-group-mail-1-face
510   '((((class color)
511       (background dark))
512      (:foreground "aquamarine1" :bold t))
513     (((class color)
514       (background light))
515      (:foreground "DeepPink3" :bold t))
516     (t
517      (:bold t)))
518   "Level 1 mailgroup face.")
519
520 (defface gnus-group-mail-1-empty-face
521   '((((class color)
522       (background dark))
523      (:foreground "aquamarine1"))
524     (((class color)
525       (background light))
526      (:foreground "DeepPink3"))
527     (t
528      (:italic t :bold t)))
529   "Level 1 empty mailgroup face.")
530
531 (defface gnus-group-mail-2-face
532   '((((class color)
533       (background dark))
534      (:foreground "aquamarine2" :bold t))
535     (((class color)
536       (background light))
537      (:foreground "HotPink3" :bold t))
538     (t
539      (:bold t)))
540   "Level 2 mailgroup face.")
541
542 (defface gnus-group-mail-2-empty-face
543   '((((class color)
544       (background dark))
545      (:foreground "aquamarine2"))
546     (((class color)
547       (background light))
548      (:foreground "HotPink3"))
549     (t
550      (:bold t)))
551   "Level 2 empty mailgroup face.")
552
553 (defface gnus-group-mail-3-face
554   '((((class color)
555       (background dark))
556      (:foreground "aquamarine3" :bold t))
557     (((class color)
558       (background light))
559      (:foreground "magenta4" :bold t))
560     (t
561      (:bold t)))
562   "Level 3 mailgroup face.")
563
564 (defface gnus-group-mail-3-empty-face
565   '((((class color)
566       (background dark))
567      (:foreground "aquamarine3"))
568     (((class color)
569       (background light))
570      (:foreground "magenta4"))
571     (t
572      ()))
573   "Level 3 empty mailgroup face.")
574
575 (defface gnus-group-mail-low-face
576   '((((class color)
577       (background dark))
578      (:foreground "aquamarine4" :bold t))
579     (((class color)
580       (background light))
581      (:foreground "DeepPink4" :bold t))
582     (t
583      (:bold t)))
584   "Low level mailgroup face.")
585
586 (defface gnus-group-mail-low-empty-face
587   '((((class color)
588       (background dark))
589      (:foreground "aquamarine4"))
590     (((class color)
591       (background light))
592      (:foreground "DeepPink4"))
593     (t
594      (:bold t)))
595   "Low level empty mailgroup face.")
596
597 ;; Summary mode faces.
598
599 (defface gnus-summary-selected-face '((t
600                                        (:underline t)))
601   "Face used for selected articles.")
602
603 (defface gnus-summary-cancelled-face
604   '((((class color))
605      (:foreground "yellow" :background "black")))
606   "Face used for cancelled articles.")
607
608 (defface gnus-summary-high-ticked-face
609   '((((class color)
610       (background dark))
611      (:foreground "pink" :bold t))
612     (((class color)
613       (background light))
614      (:foreground "firebrick" :bold t))
615     (t
616      (:bold t)))
617   "Face used for high interest ticked articles.")
618
619 (defface gnus-summary-low-ticked-face
620   '((((class color)
621       (background dark))
622      (:foreground "pink" :italic t))
623     (((class color)
624       (background light))
625      (:foreground "firebrick" :italic t))
626     (t
627      (:italic t)))
628   "Face used for low interest ticked articles.")
629
630 (defface gnus-summary-normal-ticked-face
631   '((((class color)
632       (background dark))
633      (:foreground "pink"))
634     (((class color)
635       (background light))
636      (:foreground "firebrick"))
637     (t
638      ()))
639   "Face used for normal interest ticked articles.")
640
641 (defface gnus-summary-high-ancient-face
642   '((((class color)
643       (background dark))
644      (:foreground "SkyBlue" :bold t))
645     (((class color)
646       (background light))
647      (:foreground "RoyalBlue" :bold t))
648     (t
649      (:bold t)))
650   "Face used for high interest ancient articles.")
651
652 (defface gnus-summary-low-ancient-face
653   '((((class color)
654       (background dark))
655      (:foreground "SkyBlue" :italic t))
656     (((class color)
657       (background light))
658      (:foreground "RoyalBlue" :italic t))
659     (t
660      (:italic t)))
661   "Face used for low interest ancient articles.")
662
663 (defface gnus-summary-normal-ancient-face
664   '((((class color)
665       (background dark))
666      (:foreground "SkyBlue"))
667     (((class color)
668       (background light))
669      (:foreground "RoyalBlue"))
670     (t
671      ()))
672   "Face used for normal interest ancient articles.")
673
674 (defface gnus-summary-high-undownloaded-face
675    '((((class color)
676        (background light))
677       (:bold t :foreground "cyan4"))
678      (((class color) (background dark))
679       (:bold t :foreground "LightGray"))
680      (t (:inverse-video t :bold t)))
681   "Face used for high interest uncached articles.")
682
683 (defface gnus-summary-low-undownloaded-face
684    '((((class color)
685        (background light))
686       (:italic t :foreground "cyan4" :bold nil))
687      (((class color) (background dark))
688       (:italic t :foreground "LightGray" :bold nil))
689      (t (:inverse-video t :italic t)))
690   "Face used for low interest uncached articles.")
691
692 (defface gnus-summary-normal-undownloaded-face
693    '((((class color)
694        (background light))
695       (:foreground "cyan4" :bold nil))
696      (((class color) (background dark))
697       (:foreground "LightGray" :bold nil))
698      (t (:inverse-video t)))
699   "Face used for normal interest uncached articles.")
700
701 (defface gnus-summary-high-unread-face
702   '((t
703      (:bold t)))
704   "Face used for high interest unread articles.")
705
706 (defface gnus-summary-low-unread-face
707   '((t
708      (:italic t)))
709   "Face used for low interest unread articles.")
710
711 (defface gnus-summary-normal-unread-face
712   '((t
713      ()))
714   "Face used for normal interest unread articles.")
715
716 (defface gnus-summary-incorporated-face
717   '((t
718      ()))
719   "Face used for incorporated articles.")
720
721 (defface gnus-summary-high-read-face
722   '((((class color)
723       (background dark))
724      (:foreground "PaleGreen"
725                   :bold t))
726     (((class color)
727       (background light))
728      (:foreground "DarkGreen"
729                   :bold t))
730     (t
731      (:bold t)))
732   "Face used for high interest read articles.")
733
734 (defface gnus-summary-low-read-face
735   '((((class color)
736       (background dark))
737      (:foreground "PaleGreen"
738                   :italic t))
739     (((class color)
740       (background light))
741      (:foreground "DarkGreen"
742                   :italic t))
743     (t
744      (:italic t)))
745   "Face used for low interest read articles.")
746
747 (defface gnus-summary-normal-read-face
748   '((((class color)
749       (background dark))
750      (:foreground "PaleGreen"))
751     (((class color)
752       (background light))
753      (:foreground "DarkGreen"))
754     (t
755      ()))
756   "Face used for normal interest read articles.")
757
758
759 ;;;
760 ;;; Gnus buffers
761 ;;;
762
763 (defvar gnus-buffers nil)
764
765 (defun gnus-get-buffer-create (name)
766   "Do the same as `get-buffer-create', but store the created buffer."
767   (or (get-buffer name)
768       (car (push (get-buffer-create name) gnus-buffers))))
769
770 (defun gnus-add-buffer ()
771   "Add the current buffer to the list of Gnus buffers."
772   (push (current-buffer) gnus-buffers))
773
774 (defmacro gnus-kill-buffer (buffer)
775   "Kill BUFFER and remove from the list of Gnus buffers."
776   `(let ((buf ,buffer))
777      (when (gnus-buffer-exists-p buf)
778        (setq gnus-buffers (delete (get-buffer buf) gnus-buffers))
779        (kill-buffer buf))))
780
781 (defun gnus-buffers ()
782   "Return a list of live Gnus buffers."
783   (while (and gnus-buffers
784               (not (buffer-name (car gnus-buffers))))
785     (pop gnus-buffers))
786   (let ((buffers gnus-buffers))
787     (while (cdr buffers)
788       (if (buffer-name (cadr buffers))
789           (pop buffers)
790         (setcdr buffers (cddr buffers)))))
791   gnus-buffers)
792
793 ;;; Splash screen.
794
795 (defvar gnus-group-buffer "*Group*")
796
797 (eval-and-compile
798   (autoload 'gnus-play-jingle "gnus-audio"))
799
800 (defface gnus-splash-face
801   '((((class color)
802       (background dark))
803      (:foreground "#888888"))
804     (((class color)
805       (background light))
806      (:foreground "#888888"))
807     (t
808      ()))
809   "Face for the splash screen.")
810
811 (defun gnus-splash ()
812   (save-excursion
813     (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
814     (let ((buffer-read-only nil))
815       (erase-buffer)
816       (unless gnus-inhibit-startup-message
817         (gnus-group-startup-message)
818         (sit-for 0)
819         (when gnus-play-startup-jingle
820           (gnus-play-jingle))))))
821
822 (defun gnus-indent-rigidly (start end arg)
823   "Indent rigidly using only spaces and no tabs."
824   (save-excursion
825     (save-restriction
826       (narrow-to-region start end)
827       (let ((tab-width 8))
828         (indent-rigidly start end arg)
829         ;; We translate tabs into spaces -- not everybody uses
830         ;; an 8-character tab.
831         (goto-char (point-min))
832         (while (search-forward "\t" nil t)
833           (replace-match "        " t t))))))
834
835 (defvar gnus-simple-splash nil)
836
837 ;;(format "%02x%02x%02x" 114 66 20) "724214"
838
839 (defvar gnus-logo-color-alist
840   '((flame "#cc3300" "#ff2200")
841     (pine "#c0cc93" "#f8ffb8")
842     (moss "#a1cc93" "#d2ffb8")
843     (irish "#04cc90" "#05ff97")
844     (sky "#049acc" "#05deff")
845     (tin "#6886cc" "#82b6ff")
846     (velvet "#7c68cc" "#8c82ff")
847     (grape "#b264cc" "#cf7df")
848     (labia "#cc64c2" "#fd7dff")
849     (berry "#cc6485" "#ff7db5")
850     (dino "#724214" "#1e3f03")
851     (oort "#cccccc" "#888888")
852     (storm "#666699" "#99ccff")
853     (pdino "#9999cc" "#99ccff")
854     (purp "#9999cc" "#666699")
855     (no "#ff0000" "#ffff00")
856     (neutral "#b4b4b4" "#878787")
857     (september "#bf9900" "#ffcc00"))
858   "Color alist used for the Gnus logo.")
859
860 (defcustom gnus-logo-color-style 'no
861   "*Color styles used for the Gnus logo."
862   :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem)))
863                            gnus-logo-color-alist))
864   :group 'gnus-xmas)
865
866 (defvar gnus-logo-colors
867   (cdr (assq gnus-logo-color-style gnus-logo-color-alist))
868   "Colors used for the Gnus logo.")
869
870 (defun gnus-group-startup-message (&optional x y)
871   "Insert startup message in current buffer."
872   ;; Insert the message.
873   (erase-buffer)
874   (cond
875    ((and (fboundp 'find-image)
876          (display-graphic-p)
877          (let* ((bg (face-background 'default))
878                 (fg (face-foreground 'gnus-splash-face))
879                 (data-directory (nnheader-find-etc-directory "gnus"))
880                 (image (find-image
881                         `((:type xpm :file "gnus.xpm"
882                                  :color-symbols
883                                  (("thing" . ,(car gnus-logo-colors))
884                                   ("shadow" . ,(cadr gnus-logo-colors))
885                                   ("oort" . "#eeeeee")
886                                   ("background" . ,bg)))
887                           (:type pbm :file "gnus.pbm"
888                                  ;; Account for the pbm's blackground.
889                                  :background ,bg :foreground ,fg)
890                           (:type xbm :file "gnus.xbm"
891                                  ;; Account for the xbm's blackground.
892                                  :background ,bg :foreground ,fg)))))
893            (when image
894              (insert
895               (propertize
896                (concat gnus-product-name " " gnus-version-number
897                        (if (zerop (string-to-number gnus-revision-number))
898                            ""
899                          (concat " (r" gnus-revision-number ")"))
900                        " based on " gnus-original-product-name " v"
901                        gnus-original-version-number)
902                'face `(variable-pitch :background ,bg :foreground ,fg)))
903              (let ((fill-column (window-width)))
904                (center-region (point-min) (point)))
905              (let ((size (image-size image)))
906                (insert-char ?\n (max 1 (round (- (window-height)
907                                                  (or y (cdr size))) 2)))
908                (insert
909                 (propertize " " 'display
910                             `(space :align-to
911                                     ,(max 0 (round (- (window-width)
912                                                       (or x (car size))) 2)))))
913                (insert-image image))
914              (setq gnus-simple-splash nil)
915              t))))
916    (t
917     (insert "
918           _    ___ _             _
919           _ ___ __ ___  __    _ ___
920           __   _     ___    __  ___
921               _           ___     _
922              _  _ __             _
923              ___   __            _
924                    __           _
925                     _      _   _
926                    _      _    _
927                       _  _    _
928                   __  ___
929                  _   _ _     _
930                 _   _
931               _    _
932              _    _
933             _
934           __
935
936 "
937             )
938     (goto-char (point-min))
939     (insert gnus-product-name " " gnus-version-number
940             (if (zerop (string-to-number gnus-revision-number))
941                 ""
942               (concat " (r" gnus-revision-number ")"))
943             " based on " gnus-original-product-name " v"
944             gnus-original-version-number)
945     (insert-char ?\  (prog1
946                          (max 0 (/ (- (window-width) (point)) 2))
947                        (goto-char (point-min))))
948     (forward-line 1)
949     ;; And then hack it.
950     (gnus-indent-rigidly (point) (point-max)
951                          (/ (max (- (window-width) (or x 46)) 0) 2))
952     (goto-char (point-min))
953     (forward-line 1)
954     (let* ((pheight (count-lines (point-min) (point-max)))
955            (wheight (window-height))
956            (rest (- wheight pheight)))
957       (insert (make-string (max 0 (* 2 (/ rest 3))) ?\n)))
958     ;; Fontify some.
959     (put-text-property (point-min) (point-max) 'face 'gnus-splash-face)
960     (setq gnus-simple-splash t)))
961   (goto-char (point-min))
962   (setq mode-line-buffer-identification (concat " " gnus-version))
963   (set-buffer-modified-p t))
964
965 (eval-when (load)
966   (let ((command (format "%s" this-command)))
967     (when (string-match "gnus" command)
968       (if (string-match "gnus-other-frame" command)
969           (gnus-get-buffer-create gnus-group-buffer)
970         (gnus-splash)))))
971
972 ;;; Do the rest.
973
974 (require 'gnus-util)
975 (require 'nnheader)
976
977 (defcustom gnus-parameters nil
978   "Alist of group parameters.
979
980 For example:
981    ((\"mail\\\\..*\"  (gnus-show-threads nil)
982                   (gnus-use-scoring nil)
983                   (gnus-summary-line-format
984                         \"%U%R%z%I%(%[%d:%ub%-23,23f%]%) %s\\n\")
985                   (gcc-self . t)
986                   (display . all))
987      (\"mail\\\\.me\" (gnus-use-scoring  t))
988      (\"list\\\\..*\" (total-expire . t)
989                   (broken-reply-to . t)))"
990   :group 'gnus-group-various
991   :type '(repeat (cons regexp
992                        (repeat sexp))))
993
994 (defvar gnus-group-parameters-more nil)
995
996 (defvar gnus-colon-keywords
997   (eval-when-compile
998     (when (boundp 'dgnushack-colon-keywords)
999       (symbol-value 'dgnushack-colon-keywords)))
1000   "List of the colon keywords should be bound at run-time.  This variable
1001 defaults to a proper value only if this file is byte-compiled by make.")
1002
1003 (dolist (keyword gnus-colon-keywords)
1004   (set keyword keyword))
1005
1006 (defmacro gnus-define-group-parameter (param &rest rest)
1007   "Define a group parameter PARAM.
1008 REST is a plist of following:
1009 :type               One of `bool', `list' or nil.
1010 :function           The name of the function.
1011 :function-document  The documentation of the function.
1012 :parameter-type     The type for customizing the parameter.
1013 :parameter-document The documentation for the parameter.
1014 :variable           The name of the variable.
1015 :variable-document  The documentation for the variable.
1016 :variable-group     The group for customizing the variable.
1017 :variable-type      The type for customizing the variable.
1018 :variable-default   The default value of the variable."
1019   (let* ((type (plist-get rest :type))
1020          (parameter-type (plist-get rest :parameter-type))
1021          (parameter-document (plist-get rest :parameter-document))
1022          (function (or (plist-get rest :function)
1023                        (intern (format "gnus-parameter-%s" param))))
1024          (function-document (or (plist-get rest :function-document) ""))
1025          (variable (or (plist-get rest :variable)
1026                        (intern (format "gnus-parameter-%s-alist" param))))
1027          (variable-document (or (plist-get rest :variable-document) ""))
1028          (variable-group (plist-get rest :variable-group))
1029          (variable-type (or (plist-get rest :variable-type)
1030                             `(quote (repeat
1031                                      (list (regexp :tag "Group")
1032                                            ,(car (cdr parameter-type)))))))
1033          (variable-default (plist-get rest :variable-default)))
1034     (list
1035      'progn
1036      `(defcustom ,variable ,variable-default
1037         ,variable-document
1038         :group 'gnus-group-parameter
1039         :group ',variable-group
1040         :type ,variable-type)
1041      `(setq gnus-group-parameters-more
1042             (delq (assq ',param gnus-group-parameters-more)
1043                   gnus-group-parameters-more))
1044      `(add-to-list 'gnus-group-parameters-more
1045                    (list ',param
1046                          ,parameter-type
1047                          ,parameter-document))
1048      (if (eq type 'bool)
1049          `(defun ,function (name)
1050             ,function-document
1051             (let ((params (gnus-group-find-parameter name))
1052                   val)
1053               (cond
1054                ((memq ',param params)
1055                 t)
1056                ((setq val (assq ',param params))
1057                 (cdr val))
1058                ((stringp ,variable)
1059                 (string-match ,variable name))
1060                (,variable
1061                 (let ((alist ,variable)
1062                       elem value)
1063                   (while (setq elem (pop alist))
1064                     (when (and name
1065                                (string-match (car elem) name))
1066                       (setq alist nil
1067                             value (cdr elem))))
1068                   (if (consp value) (car value) value))))))
1069        `(defun ,function (name)
1070           ,function-document
1071           (and name
1072                (or (gnus-group-find-parameter name ',param ,(and type t))
1073                    (let ((alist ,variable)
1074                          elem value)
1075                      (while (setq elem (pop alist))
1076                        (when (and name
1077                                   (string-match (car elem) name))
1078                          (setq alist nil
1079                                value (cdr elem))))
1080                      ,(if type
1081                           'value
1082                         '(if (consp value) (car value) value))))))))))
1083
1084 (defcustom gnus-home-directory "~/"
1085   "Directory variable that specifies the \"home\" directory.
1086 All other Gnus file and directory variables are initialized from this variable."
1087   :group 'gnus-files
1088   :type 'directory)
1089
1090 (defcustom gnus-directory (or (getenv "SAVEDIR")
1091                               (nnheader-concat gnus-home-directory "News/"))
1092   "*Directory variable from which all other Gnus file variables are derived.
1093
1094 Note that Gnus is mostly loaded when the `.gnus.el' file is read.
1095 This means that other directory variables that are initialized from
1096 this variable won't be set properly if you set this variable in `.gnus.el'.
1097 Set this variable in `.emacs' instead."
1098   :group 'gnus-files
1099   :type 'directory)
1100
1101 (defcustom gnus-default-directory nil
1102   "*Default directory for all Gnus buffers."
1103   :group 'gnus-files
1104   :type '(choice (const :tag "current" nil)
1105                  directory))
1106
1107 ;; Site dependent variables.  These variables should be defined in
1108 ;; paths.el.
1109
1110 (defvar gnus-default-nntp-server nil
1111   "Specify a default NNTP server.
1112 This variable should be defined in paths.el, and should never be set
1113 by the user.
1114 If you want to change servers, you should use `gnus-select-method'.
1115 See the documentation to that variable.")
1116
1117 ;; Don't touch this variable.
1118 (defvar gnus-nntp-service "nntp"
1119   "NNTP service name (\"nntp\" or 119).
1120 This is an obsolete variable, which is scarcely used.  If you use an
1121 nntp server for your newsgroup and want to change the port number
1122 used to 899, you would say something along these lines:
1123
1124  (setq gnus-select-method '(nntp \"my.nntp.server\" (nntp-port-number 899)))")
1125
1126 (defcustom gnus-nntpserver-file "/etc/nntpserver"
1127   "A file with only the name of the nntp server in it."
1128   :group 'gnus-files
1129   :group 'gnus-server
1130   :type 'file)
1131
1132 (defun gnus-getenv-nntpserver ()
1133   "Find default nntp server.
1134 Check the NNTPSERVER environment variable and the
1135 `gnus-nntpserver-file' file."
1136   (or (getenv "NNTPSERVER")
1137       (and (file-readable-p gnus-nntpserver-file)
1138            (with-temp-buffer
1139              (insert-file-contents gnus-nntpserver-file)
1140              (let ((name (buffer-string)))
1141                (unless (string-match "\\`[ \t\n]*$" name)
1142                  name))))))
1143
1144 (defcustom gnus-select-method
1145   (condition-case nil
1146       (nconc
1147        (list 'nntp (or (condition-case nil
1148                            (gnus-getenv-nntpserver)
1149                          (error nil))
1150                        (when (and gnus-default-nntp-server
1151                                   (not (string= gnus-default-nntp-server "")))
1152                          gnus-default-nntp-server)
1153                        "news"))
1154        (if (or (null gnus-nntp-service)
1155                (equal gnus-nntp-service "nntp"))
1156            nil
1157          (list gnus-nntp-service)))
1158     (error nil))
1159   "Default method for selecting a newsgroup.
1160 This variable should be a list, where the first element is how the
1161 news is to be fetched, the second is the address.
1162
1163 For instance, if you want to get your news via \"flab.flab.edu\" using
1164 NNTP, you could say:
1165
1166 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1167
1168 If you want to use your local spool, say:
1169
1170 \(setq gnus-select-method (list 'nnspool (system-name)))
1171
1172 If you use this variable, you must set `gnus-nntp-server' to nil.
1173
1174 There is a lot more to know about select methods and virtual servers -
1175 see the manual for details."
1176   :group 'gnus-server
1177   :type 'gnus-select-method)
1178
1179 (defcustom gnus-message-archive-method "archive"
1180   "*Method used for archiving messages you've sent.
1181 This should be a mail method."
1182   :group 'gnus-server
1183   :group 'gnus-message
1184   :type '(choice (const :tag "Default archive method" "archive")
1185                  gnus-select-method))
1186
1187 (defcustom gnus-message-archive-group nil
1188   "*Name of the group in which to save the messages you've written.
1189 This can either be a string; a list of strings; or an alist
1190 of regexps/functions/forms to be evaluated to return a string (or a list
1191 of strings).  The functions are called with the name of the current
1192 group (or nil) as a parameter.
1193
1194 If you want to save your mail in one group and the news articles you
1195 write in another group, you could say something like:
1196
1197  \(setq gnus-message-archive-group
1198         '((if (message-news-p)
1199               \"misc-news\"
1200             \"misc-mail\")))
1201
1202 Normally the group names returned by this variable should be
1203 unprefixed -- which implicitly means \"store on the archive server\".
1204 However, you may wish to store the message on some other server.  In
1205 that case, just return a fully prefixed name of the group --
1206 \"nnml+private:mail.misc\", for instance."
1207   :group 'gnus-message
1208   :type '(choice (const :tag "none" nil)
1209                  function
1210                  sexp
1211                  string))
1212
1213 (defcustom gnus-secondary-servers nil
1214   "List of NNTP servers that the user can choose between interactively.
1215 To make Gnus query you for a server, you have to give `gnus' a
1216 non-numeric prefix - `C-u M-x gnus', in short."
1217   :group 'gnus-server
1218   :type '(repeat string))
1219
1220 (defcustom gnus-nntp-server nil
1221   "*The name of the host running the NNTP server.
1222 This variable is semi-obsolete.  Use the `gnus-select-method'
1223 variable instead."
1224   :group 'gnus-server
1225   :type '(choice (const :tag "disable" nil)
1226                  string))
1227
1228 (defcustom gnus-secondary-select-methods nil
1229   "A list of secondary methods that will be used for reading news.
1230 This is a list where each element is a complete select method (see
1231 `gnus-select-method').
1232
1233 If, for instance, you want to read your mail with the nnml back end,
1234 you could set this variable:
1235
1236 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1237   :group 'gnus-server
1238   :type '(repeat gnus-select-method))
1239
1240 (defvar gnus-backup-default-subscribed-newsgroups
1241   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1242   "Default default new newsgroups the first time Gnus is run.
1243 Should be set in paths.el, and shouldn't be touched by the user.")
1244
1245 (defcustom gnus-local-domain nil
1246   "Local domain name without a host name.
1247 The DOMAINNAME environment variable is used instead if it is defined.
1248 If the function `system-name' returns the full Internet name, there is
1249 no need to set this variable."
1250   :group 'gnus-message
1251   :type '(choice (const :tag "default" nil)
1252                  string))
1253
1254 (defvar gnus-local-organization nil
1255   "String with a description of what organization (if any) the user belongs to.
1256 Obsolete variable; use `message-user-organization' instead.")
1257
1258 ;; Customization variables
1259
1260 (defcustom gnus-refer-article-method nil
1261   "Preferred method for fetching an article by Message-ID.
1262 If you are reading news from the local spool (with nnspool), fetching
1263 articles by Message-ID is painfully slow.  By setting this method to an
1264 nntp method, you might get acceptable results.
1265
1266 The value of this variable must be a valid select method as discussed
1267 in the documentation of `gnus-select-method'.
1268
1269 It can also be a list of select methods, as well as the special symbol
1270 `current', which means to use the current select method.  If it is a
1271 list, Gnus will try all the methods in the list until it finds a match."
1272   :group 'gnus-server
1273   :type '(choice (const :tag "default" nil)
1274                  (const current)
1275                  (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1276                  gnus-select-method
1277                  (repeat :menu-tag "Try multiple"
1278                          :tag "Multiple"
1279                          :value (current (nnweb "refer" (nnweb-type google)))
1280                          (choice :tag "Method"
1281                                  (const current)
1282                                  (const :tag "Google"
1283                                         (nnweb "refer" (nnweb-type google)))
1284                                  gnus-select-method))))
1285
1286 (defcustom gnus-group-faq-directory
1287   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1288     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1289     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1290     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1291     "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1292     "/ftp@rtfm.mit.edu:/pub/usenet/"
1293     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1294     "/ftp@ftp.sunet.se:/pub/usenet/"
1295     "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1296     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1297     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1298   "*Directory where the group FAQs are stored.
1299 This will most commonly be on a remote machine, and the file will be
1300 fetched by ange-ftp.
1301
1302 This variable can also be a list of directories.  In that case, the
1303 first element in the list will be used by default.  The others can
1304 be used when being prompted for a site.
1305
1306 Note that Gnus uses an aol machine as the default directory.  If this
1307 feels fundamentally unclean, just think of it as a way to finally get
1308 something of value back from them.
1309
1310 If the default site is too slow, try one of these:
1311
1312    North America: mirrors.aol.com                /pub/rtfm/usenet
1313                   ftp.seas.gwu.edu               /pub/rtfm
1314                   rtfm.mit.edu                   /pub/usenet
1315    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1316                   src.doc.ic.ac.uk               /usenet/news-FAQS
1317                   ftp.sunet.se                   /pub/usenet
1318                   ftp.pasteur.fr                 /pub/FAQ
1319    Asia:          nctuccca.nctu.edu.tw           /pub/Documents/rtfm/usenet-by-group/
1320                   hwarang.postech.ac.kr          /pub/usenet
1321                   ftp.hk.super.net               /mirror/faqs"
1322   :group 'gnus-group-various
1323   :type '(choice directory
1324                  (repeat directory)))
1325
1326 (defcustom gnus-group-charter-alist
1327   '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1328     ("de" . (concat "http://purl.net/charta/" name ".html"))
1329     ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1330     ("england" . (concat "http://england.news-admin.org/charters/" name))
1331     ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1332     ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1333                         (gnus-replace-in-string name "europa\\." "") ".html"))
1334     ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1335     ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1336     ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1337     ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1338     ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1339     ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1340     ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1341     ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1342                     (gnus-replace-in-string name "\\." "_") ".html"))
1343     ("milw" . (concat "http://usenet.mil.wi.us/"
1344                       (gnus-replace-in-string name "milw\\." "") "-charter"))
1345     ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1346     ("netins" . (concat "http://www.netins.net/usenet/charter/"
1347                         (gnus-replace-in-string name "\\." "-") "-charter.html")))
1348   "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1349 When FORM is evaluated `name' is bound to the name of the group."
1350   :group 'gnus-group-various
1351   :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1352
1353 (defcustom gnus-group-fetch-control-use-browse-url nil
1354   "*Non-nil means that control messages are displayed using `browse-url'.
1355 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1356 group."
1357   :group 'gnus-group-various
1358   :type 'boolean)
1359
1360 (defcustom gnus-use-cross-reference t
1361   "*Non-nil means that cross referenced articles will be marked as read.
1362 If nil, ignore cross references.  If t, mark articles as read in
1363 subscribed newsgroups.  If neither t nor nil, mark as read in all
1364 newsgroups."
1365   :group 'gnus-server
1366   :type '(choice (const :tag "off" nil)
1367                  (const :tag "subscribed" t)
1368                  (sexp :format "all"
1369                        :value always)))
1370
1371 (defcustom gnus-process-mark ?#
1372   "*Process mark."
1373   :group 'gnus-group-visual
1374   :group 'gnus-summary-marks
1375   :type 'character)
1376
1377 (defcustom gnus-large-newsgroup 200
1378   "*The number of articles which indicates a large newsgroup.
1379 If the number of articles in a newsgroup is greater than this value,
1380 confirmation is required for selecting the newsgroup.
1381 If it is nil, no confirmation is required."
1382   :group 'gnus-group-select
1383   :type '(choice (const :tag "No limit" nil)
1384                  integer))
1385
1386 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1387   "*Non-nil means that the default name of a file to save articles in is the group name.
1388 If it's nil, the directory form of the group name is used instead.
1389
1390 If this variable is a list, and the list contains the element
1391 `not-score', long file names will not be used for score files; if it
1392 contains the element `not-save', long file names will not be used for
1393 saving; and if it contains the element `not-kill', long file names
1394 will not be used for kill files.
1395
1396 Note that the default for this variable varies according to what system
1397 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1398 to nil while on all other systems it defaults to t."
1399   :group 'gnus-start
1400   :type '(radio (sexp :format "Non-nil\n"
1401                       :match (lambda (widget value)
1402                                (and value (not (listp value))))
1403                       :value t)
1404                 (const nil)
1405                 (checklist (const :format "%v " not-score)
1406                            (const :format "%v " not-save)
1407                            (const not-kill))))
1408
1409 (defcustom gnus-kill-files-directory gnus-directory
1410   "*Name of the directory where kill files will be stored (default \"~/News\")."
1411   :group 'gnus-score-files
1412   :group 'gnus-score-kill
1413   :type 'directory)
1414
1415 (defcustom gnus-save-score nil
1416   "*If non-nil, save group scoring info."
1417   :group 'gnus-score-various
1418   :group 'gnus-start
1419   :type 'boolean)
1420
1421 (defcustom gnus-use-undo t
1422   "*If non-nil, allow undoing in Gnus group mode buffers."
1423   :group 'gnus-meta
1424   :type 'boolean)
1425
1426 (defcustom gnus-use-adaptive-scoring nil
1427   "*If non-nil, use some adaptive scoring scheme.
1428 If a list, then the values `word' and `line' are meaningful.  The
1429 former will perform adaption on individual words in the subject
1430 header while `line' will perform adaption on several headers."
1431   :group 'gnus-meta
1432   :group 'gnus-score-adapt
1433   :type '(set (const word) (const line)))
1434
1435 (defcustom gnus-use-cache 'passive
1436   "*If nil, Gnus will ignore the article cache.
1437 If `passive', it will allow entering (and reading) articles
1438 explicitly entered into the cache.  If anything else, use the
1439 cache to the full extent of the law."
1440   :group 'gnus-meta
1441   :group 'gnus-cache
1442   :type '(choice (const :tag "off" nil)
1443                  (const :tag "passive" passive)
1444                  (const :tag "active" t)))
1445
1446 (defcustom gnus-use-trees nil
1447   "*If non-nil, display a thread tree buffer."
1448   :group 'gnus-meta
1449   :type 'boolean)
1450
1451 (defcustom gnus-keep-backlog 20
1452   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1453 If it is a number N, then Gnus will only keep the last N articles
1454 read.  If it is neither nil nor a number, Gnus will keep all read
1455 articles.  This is not a good idea."
1456   :group 'gnus-meta
1457   :type '(choice (const :tag "off" nil)
1458                  integer
1459                  (sexp :format "all"
1460                        :value t)))
1461
1462 (defcustom gnus-use-nocem nil
1463   "*If non-nil, Gnus will read NoCeM cancel messages."
1464   :group 'gnus-meta
1465   :type 'boolean)
1466
1467 (defcustom gnus-suppress-duplicates nil
1468   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1469   :group 'gnus-meta
1470   :type 'boolean)
1471
1472 (defcustom gnus-use-scoring t
1473   "*If non-nil, enable scoring."
1474   :group 'gnus-meta
1475   :type 'boolean)
1476
1477 (defcustom gnus-summary-prepare-exit-hook
1478   '(gnus-summary-expire-articles)
1479   "*A hook called when preparing to exit from the summary buffer.
1480 It calls `gnus-summary-expire-articles' by default."
1481   :group 'gnus-summary-exit
1482   :type 'hook)
1483
1484 (defcustom gnus-novice-user t
1485   "*Non-nil means that you are a Usenet novice.
1486 If non-nil, verbose messages may be displayed and confirmations may be
1487 required."
1488   :group 'gnus-meta
1489   :type 'boolean)
1490
1491 (defcustom gnus-expert-user nil
1492   "*Non-nil means that you will never be asked for confirmation about anything.
1493 That doesn't mean *anything* anything; particularly destructive
1494 commands will still require prompting."
1495   :group 'gnus-meta
1496   :type 'boolean)
1497
1498 (defcustom gnus-interactive-catchup t
1499   "*If non-nil, require your confirmation when catching up a group."
1500   :group 'gnus-group-select
1501   :type 'boolean)
1502
1503 (defcustom gnus-interactive-exit t
1504   "*If non-nil, require your confirmation when exiting Gnus."
1505   :group 'gnus-exit
1506   :type 'boolean)
1507
1508 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1509   "Function for extracting address components from a From header.
1510 Three pre-defined functions exist: `gnus-extract-address-components',
1511 which is the default, quite fast, and too simplistic solution,
1512 `mail-extract-address-components', which works much better, but is
1513 slower, and `std11-extract-address-components'."
1514   :group 'gnus-summary-format
1515   :type '(radio (function-item gnus-extract-address-components)
1516                 (function-item mail-extract-address-components)
1517                 (function-item std11-extract-address-components)
1518                 (function :tag "Other")))
1519
1520 (defcustom gnus-carpal nil
1521   "*If non-nil, display clickable icons."
1522   :group 'gnus-meta
1523   :type 'boolean)
1524
1525 (defcustom gnus-shell-command-separator ";"
1526   "String used to separate shell commands."
1527   :group 'gnus-files
1528   :type 'string)
1529
1530 (defcustom gnus-valid-select-methods
1531   '(("nntp" post address prompt-address physical-address)
1532     ("nnspool" post address)
1533     ("nnvirtual" post-mail virtual prompt-address)
1534     ("nnmbox" mail respool address)
1535     ("nnml" post-mail respool address)
1536     ("nnmh" mail respool address)
1537     ("nndir" post-mail prompt-address physical-address)
1538     ("nneething" none address prompt-address physical-address)
1539     ("nndoc" none address prompt-address)
1540     ("nnbabyl" mail address respool)
1541     ("nnkiboze" post virtual)
1542     ("nnsoup" post-mail address)
1543     ("nndraft" post-mail)
1544     ("nnfolder" mail respool address)
1545     ("nngateway" post-mail address prompt-address physical-address)
1546     ("nnweb" none)
1547     ("nngoogle" post)
1548     ("nnslashdot" post)
1549     ("nnultimate" none)
1550     ("nnrss" none)
1551     ("nnwfm" none)
1552     ("nnwarchive" none)
1553     ("nnlistserv" none)
1554     ("nnagent" post-mail)
1555     ("nnimap" post-mail address prompt-address physical-address)
1556     ("nnmaildir" mail respool address)
1557     ("nnnil" none))
1558   "*An alist of valid select methods.
1559 The first element of each list lists should be a string with the name
1560 of the select method.  The other elements may be the category of
1561 this method (i. e., `post', `mail', `none' or whatever) or other
1562 properties that this method has (like being respoolable).
1563 If you implement a new select method, all you should have to change is
1564 this variable.  I think."
1565   :group 'gnus-server
1566   :type '(repeat (group (string :tag "Name")
1567                         (radio-button-choice (const :format "%v " post)
1568                                              (const :format "%v " mail)
1569                                              (const :format "%v " none)
1570                                              (const post-mail))
1571                         (checklist :inline t
1572                                    (const :format "%v " address)
1573                                    (const :format "%v " prompt-address)
1574                                    (const :format "%v " physical-address)
1575                                    (const :format "%v " virtual)
1576                                    (const respool)))))
1577
1578 (defun gnus-redefine-select-method-widget ()
1579   "Recomputes the select-method widget based on the value of
1580 `gnus-valid-select-methods'."
1581   (define-widget 'gnus-select-method 'list
1582     "Widget for entering a select method."
1583     :value '(nntp "")
1584     :tag "Select Method"
1585     :args `((choice :tag "Method"
1586                     ,@(mapcar (lambda (entry)
1587                                 (list 'const :format "%v\n"
1588                                       (intern (car entry))))
1589                               gnus-valid-select-methods)
1590                     (symbol :tag "other"))
1591             (string :tag "Address")
1592             (repeat :tag "Options"
1593                     :inline t
1594                     (list :format "%v"
1595                           variable
1596                           (sexp :tag "Value"))))))
1597
1598 (gnus-redefine-select-method-widget)
1599
1600 (defcustom gnus-updated-mode-lines '(group article summary tree)
1601   "List of buffers that should update their mode lines.
1602 The list may contain the symbols `group', `article', `tree' and
1603 `summary'.  If the corresponding symbol is present, Gnus will keep
1604 that mode line updated with information that may be pertinent.
1605 If this variable is nil, screen refresh may be quicker."
1606   :group 'gnus-various
1607   :type '(set (const group)
1608               (const article)
1609               (const summary)
1610               (const tree)))
1611
1612 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1613 (defcustom gnus-mode-non-string-length nil
1614   "*Max length of mode-line non-string contents.
1615 If this is nil, Gnus will take space as is needed, leaving the rest
1616 of the mode line intact.  Note that the default of nil is unlikely
1617 to be desirable; see the manual for further details."
1618   :group 'gnus-various
1619   :type '(choice (const nil)
1620                  integer))
1621
1622 ;; There should be special validation for this.
1623 (define-widget 'gnus-email-address 'string
1624   "An email address.")
1625
1626 (gnus-define-group-parameter
1627  to-address
1628  :function-document
1629  "Return GROUP's to-address."
1630  :variable-document
1631  "*Alist of group regexps and correspondent to-addresses."
1632  :parameter-type '(gnus-email-address :tag "To Address")
1633  :parameter-document "\
1634 This will be used when doing followups and posts.
1635
1636 This is primarily useful in mail groups that represent closed
1637 mailing lists--mailing lists where it's expected that everybody that
1638 writes to the mailing list is subscribed to it.  Since using this
1639 parameter ensures that the mail only goes to the mailing list itself,
1640 it means that members won't receive two copies of your followups.
1641
1642 Using `to-address' will actually work whether the group is foreign or
1643 not.  Let's say there's a group on the server that is called
1644 `fa.4ad-l'.  This is a real newsgroup, but the server has gotten the
1645 articles from a mail-to-news gateway.  Posting directly to this group
1646 is therefore impossible--you have to send mail to the mailing list
1647 address instead.
1648
1649 The gnus-group-split mail splitting mechanism will behave as if this
1650 address was listed in gnus-group-split Addresses (see below).")
1651
1652 (gnus-define-group-parameter
1653  to-list
1654  :function-document
1655  "Return GROUP's to-list."
1656  :variable-document
1657  "*Alist of group regexps and correspondent to-lists."
1658  :parameter-type '(gnus-email-address :tag "To List")
1659  :parameter-document "\
1660 This address will be used when doing a `a' in the group.
1661
1662 It is totally ignored when doing a followup--except that if it is
1663 present in a news group, you'll get mail group semantics when doing
1664 `f'.
1665
1666 The gnus-group-split mail splitting mechanism will behave as if this
1667 address was listed in gnus-group-split Addresses (see below).")
1668
1669 (gnus-define-group-parameter
1670  subscribed
1671  :type bool
1672  :function-document
1673  "Return GROUP's subscription status."
1674  :variable-document
1675  "*Groups which are automatically considered subscribed."
1676  :parameter-type '(const :tag "Subscribed" t)
1677  :parameter-document "\
1678 Gnus assumed that you are subscribed to the To/List address.
1679
1680 When constructing a list of subscribed groups using
1681 `gnus-find-subscribed-addresses', Gnus includes the To address given
1682 above, or the list address (if the To address has not been set).")
1683
1684 (gnus-define-group-parameter
1685  auto-expire
1686  :type bool
1687  :function gnus-group-auto-expirable-p
1688  :function-document
1689  "Check whether GROUP is auto-expirable or not."
1690  :variable gnus-auto-expirable-newsgroups
1691  :variable-default nil
1692  :variable-document
1693  "*Groups in which to automatically mark read articles as expirable.
1694 If non-nil, this should be a regexp that should match all groups in
1695 which to perform auto-expiry.  This only makes sense for mail groups."
1696  :variable-group nnmail-expire
1697  :variable-type '(choice (const nil)
1698                          regexp)
1699  :parameter-type '(const :tag "Automatic Expire" t)
1700  :parameter-document
1701  "All articles that are read will be marked as expirable.")
1702
1703 (gnus-define-group-parameter
1704  total-expire
1705  :type bool
1706  :function gnus-group-total-expirable-p
1707  :function-document
1708  "Check whether GROUP is total-expirable or not."
1709  :variable gnus-total-expirable-newsgroups
1710  :variable-default nil
1711  :variable-document
1712  "*Groups in which to perform expiry of all read articles.
1713 Use with extreme caution.  All groups that match this regexp will be
1714 expiring - which means that all read articles will be deleted after
1715 \(say) one week.         (This only goes for mail groups and the like, of
1716 course.)"
1717  :variable-group nnmail-expire
1718  :variable-type '(choice (const nil)
1719                          regexp)
1720  :parameter-type '(const :tag "Total Expire" t)
1721  :parameter-document
1722  "All read articles will be put through the expiry process
1723
1724 This happens even if they are not marked as expirable.
1725 Use with caution.")
1726
1727 (gnus-define-group-parameter
1728  charset
1729  :function-document
1730  "Return the default charset of GROUP."
1731  :variable gnus-group-charset-alist
1732  :variable-default
1733  '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1734    ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1735    ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1736    ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1737    ("\\(^\\|:\\)relcom\\>" koi8-r)
1738    ("\\(^\\|:\\)fido7\\>" koi8-r)
1739    ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1740    ("\\(^\\|:\\)israel\\>" iso-8859-1)
1741    ("\\(^\\|:\\)han\\>" euc-kr)
1742    ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1743    ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1744    ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1745  :variable-document
1746  "Alist of regexps (to match group names) and default charsets to be used when reading."
1747  :variable-group gnus-charset
1748  :variable-type '(repeat (list (regexp :tag "Group")
1749                                (symbol :tag "Charset")))
1750  :parameter-type '(symbol :tag "Charset")
1751  :parameter-document "\
1752 The default charset to use in the group.")
1753
1754 (gnus-define-group-parameter
1755  post-method
1756  :type list
1757  :function-document
1758  "Return a posting method for GROUP."
1759  :variable gnus-post-method-alist
1760  :variable-document
1761  "Alist of regexps (to match group names) and method to be used when
1762 posting an article."
1763  :variable-group gnus-group-foreign
1764  :parameter-type
1765  '(choice :tag "Posting Method"
1766           (const :tag "Use native server" native)
1767           (const :tag "Use current server" current)
1768           (list :convert-widget
1769                 (lambda (widget)
1770                   (list 'sexp :tag "Methods"
1771                         :value gnus-select-method))))
1772  :parameter-document
1773  "Posting method for this group.")
1774
1775 (gnus-define-group-parameter
1776  large-newsgroup-initial
1777  :type integer
1778  :function-document
1779  "Return GROUP's initial input of the number of articles."
1780  :variable-document
1781  "*Alist of group regexps and its initial input of the number of articles."
1782  :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1783                           (const :tag "All" nil)
1784                           (integer))
1785  :parameter-document "\
1786
1787 This number will be prompted as the initial value of the number of
1788 articles to list when the group is a large newsgroup (see
1789 `gnus-large-newsgroup').  If it is nil, the default value is the
1790 total number of articles in the group.")
1791
1792 ;; The Gnus registry's ignored groups
1793 (gnus-define-group-parameter
1794  registry-ignore
1795  :type list
1796  :function-document
1797  "Whether this group should be ignored by the registry."
1798  :variable gnus-registry-ignored-groups
1799  :variable-default nil
1800  :variable-document
1801  "*Groups in which the registry should be turned off."
1802  :variable-group gnus-registry
1803  :variable-type '(repeat
1804                   (list
1805                    (regexp :tag "Group Name Regular Expression")
1806                    (boolean :tag "Ignored")))
1807  
1808  :parameter-type '(boolean :tag "Group Ignored by the Registry")
1809  :parameter-document
1810  "Whether the Gnus Registry should ignore this group.")
1811
1812 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1813 (defcustom gnus-install-group-spam-parameters t
1814   "*Disable the group parameters for spam detection.
1815 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1816   :type 'boolean
1817   :group 'gnus-start)
1818
1819 (when gnus-install-group-spam-parameters
1820   (defvar gnus-group-spam-classification-spam t
1821     "Spam group classification (requires spam.el).
1822 This group contains spam messages.  On summary entry, unread messages
1823 will be marked as spam.  On summary exit, the specified spam
1824 processors will be invoked on spam-marked messages, then those
1825 messages will be expired, so the spam processor will only see a
1826 spam-marked message once.")
1827
1828   (defvar gnus-group-spam-classification-ham 'ask
1829     "The ham value for the spam group parameter (requires spam.el).
1830 On summary exit, the specified ham processors will be invoked on
1831 ham-marked messages.  Exercise caution, since the ham processor will
1832 see the same message more than once because there is no ham message
1833 registry.")
1834
1835   (gnus-define-group-parameter
1836    spam-contents
1837    :type list
1838    :function-document
1839    "The spam type (spam, ham, or neither) of the group."
1840    :variable gnus-spam-newsgroup-contents
1841    :variable-default nil
1842    :variable-document
1843    "*Groups in which to automatically mark new articles as spam on
1844 summary entry.  If non-nil, this should be a list of group name
1845 regexps that should match all groups in which to do automatic spam
1846 tagging, associated with a classification (spam, ham, or neither).
1847 This only makes sense for mail groups."
1848    :variable-group spam
1849    :variable-type '(repeat
1850                     (list :tag "Group contents spam/ham classification"
1851                           (regexp :tag "Group")
1852                           (choice
1853                            (variable-item gnus-group-spam-classification-spam)
1854                            (variable-item gnus-group-spam-classification-ham)
1855                            (const :tag "Unclassified" nil))))
1856
1857    :parameter-type '(list :tag "Group contents spam/ham classification"
1858                           (choice :tag "Group contents classification for spam sorting"
1859                                   (variable-item gnus-group-spam-classification-spam)
1860                                   (variable-item gnus-group-spam-classification-ham)
1861                                   (const :tag "Unclassified" nil)))
1862    :parameter-document
1863    "The spam classification (spam, ham, or neither) of this group.
1864 When a spam group is entered, all unread articles are marked as spam.")
1865
1866   (defvar gnus-group-spam-exit-processor-ifile "ifile"
1867     "OBSOLETE: The ifile summary exit spam processor.")
1868
1869   (defvar gnus-group-spam-exit-processor-stat "stat"
1870     "OBSOLETE: The spam-stat summary exit spam processor.")
1871
1872   (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1873     "OBSOLETE: The Bogofilter summary exit spam processor.")
1874
1875   (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1876     "OBSOLETE: The Blacklist summary exit spam processor.")
1877
1878   (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1879     "OBSOLETE: The Gmane reporting summary exit spam processor.
1880 Only applicable to NNTP groups with articles from Gmane.  See spam-report.el")
1881
1882   (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1883     "OBSOLETE: The spamoracle summary exit spam processor.")
1884
1885   (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1886     "OBSOLETE: The ifile summary exit ham processor.
1887 Only applicable to non-spam (unclassified and ham) groups.")
1888
1889   (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1890     "OBSOLETE: The Bogofilter summary exit ham processor.
1891 Only applicable to non-spam (unclassified and ham) groups.")
1892
1893   (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1894     "OBSOLETE: The spam-stat summary exit ham processor.
1895 Only applicable to non-spam (unclassified and ham) groups.")
1896
1897   (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1898     "OBSOLETE: The whitelist summary exit ham processor.
1899 Only applicable to non-spam (unclassified and ham) groups.")
1900
1901   (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1902     "OBSOLETE: The BBDB summary exit ham processor.
1903 Only applicable to non-spam (unclassified and ham) groups.")
1904
1905   (defvar gnus-group-ham-exit-processor-copy "copy"
1906     "OBSOLETE: The ham copy exit ham processor.
1907 Only applicable to non-spam (unclassified and ham) groups.")
1908
1909   (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1910     "OBSOLETE: The spamoracle summary exit ham processor.
1911 Only applicable to non-spam (unclassified and ham) groups.")
1912
1913   (gnus-define-group-parameter
1914    spam-process
1915    :type list
1916    :parameter-type 
1917    '(choice 
1918      :tag "Spam Summary Exit Processor"
1919      :value nil
1920      (list :tag "Spam Summary Exit Processor Choices"
1921            (set
1922             (variable-item gnus-group-spam-exit-processor-ifile)
1923             (variable-item gnus-group-spam-exit-processor-stat)
1924             (variable-item gnus-group-spam-exit-processor-bogofilter)
1925             (variable-item gnus-group-spam-exit-processor-blacklist)
1926             (variable-item gnus-group-spam-exit-processor-spamoracle)
1927             (variable-item gnus-group-spam-exit-processor-report-gmane)
1928             (variable-item gnus-group-ham-exit-processor-bogofilter)
1929             (variable-item gnus-group-ham-exit-processor-ifile)
1930             (variable-item gnus-group-ham-exit-processor-stat)
1931             (variable-item gnus-group-ham-exit-processor-whitelist)
1932             (variable-item gnus-group-ham-exit-processor-BBDB)
1933             (variable-item gnus-group-ham-exit-processor-spamoracle)
1934             (variable-item gnus-group-ham-exit-processor-copy)
1935             (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
1936             (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
1937             (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
1938             (const :tag "Spam: ifile"         (spam spam-use-ifile))
1939             (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
1940             (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
1941             (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
1942             (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
1943             (const :tag "Ham: ifile"          (ham spam-use-ifile))
1944             (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
1945             (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
1946             (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
1947             (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
1948             (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
1949             (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle)))))
1950    :function-document
1951    "Which spam or ham processors will be applied when the summary is exited."
1952    :variable gnus-spam-process-newsgroups
1953    :variable-default nil
1954    :variable-document
1955    "*Groups in which to automatically process spam or ham articles with
1956 a backend on summary exit.  If non-nil, this should be a list of group
1957 name regexps that should match all groups in which to do automatic
1958 spam processing, associated with the appropriate processor."
1959    :variable-group spam
1960    :variable-type 
1961    '(repeat :tag "Spam/Ham Processors"
1962             (list :tag "Spam Summary Exit Processor Choices"
1963                   (regexp :tag "Group Regexp")
1964                   (set 
1965                    :tag "Spam/Ham Summary Exit Processor"
1966                    (variable-item gnus-group-spam-exit-processor-ifile)
1967                    (variable-item gnus-group-spam-exit-processor-stat)
1968                    (variable-item gnus-group-spam-exit-processor-bogofilter)
1969                    (variable-item gnus-group-spam-exit-processor-blacklist)
1970                    (variable-item gnus-group-spam-exit-processor-spamoracle)
1971                    (variable-item gnus-group-spam-exit-processor-report-gmane)
1972                    (variable-item gnus-group-ham-exit-processor-bogofilter)
1973                    (variable-item gnus-group-ham-exit-processor-ifile)
1974                    (variable-item gnus-group-ham-exit-processor-stat)
1975                    (variable-item gnus-group-ham-exit-processor-whitelist)
1976                    (variable-item gnus-group-ham-exit-processor-BBDB)
1977                    (variable-item gnus-group-ham-exit-processor-spamoracle)
1978                    (variable-item gnus-group-ham-exit-processor-copy)
1979                    (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
1980                    (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
1981                    (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
1982                    (const :tag "Spam: ifile"         (spam spam-use-ifile))
1983                    (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
1984                    (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
1985                    (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
1986                    (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
1987                    (const :tag "Ham: ifile"          (ham spam-use-ifile))
1988                    (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
1989                    (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
1990                    (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
1991                    (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
1992                    (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
1993                    (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle)))))
1994
1995    :parameter-document
1996    "Which spam or ham processors will be applied when the summary is exited.")
1997
1998   (gnus-define-group-parameter
1999    spam-autodetect
2000    :type list
2001    :parameter-type 
2002    '(boolean :tag "Spam autodetection")
2003    :function-document
2004    "Should spam be autodetected (with spam-split) in this group?"
2005    :variable gnus-spam-autodetect
2006    :variable-default nil
2007    :variable-document
2008    "*Groups in which spam should be autodetected when they are entered.
2009    Only unseen articles will be examined, unless
2010    spam-autodetect-recheck-messages is set."
2011    :variable-group spam
2012    :variable-type 
2013    '(repeat
2014      :tag "Autodetection setting"
2015      (list
2016       (regexp :tag "Group Regexp")
2017       boolean))
2018    :parameter-document
2019    "Spam autodetection.
2020 Only unseen articles will be examined, unless
2021 spam-autodetect-recheck-messages is set.")
2022
2023   (gnus-define-group-parameter
2024    spam-autodetect-methods
2025    :type list
2026    :parameter-type 
2027    '(choice :tag "Spam autodetection-specific methods"
2028      (const none)
2029      (const default)
2030      (set :tag "Use specific methods"
2031           (variable-item spam-use-blacklist)
2032           (variable-item spam-use-regex-headers)
2033           (variable-item spam-use-regex-body)
2034           (variable-item spam-use-whitelist)
2035           (variable-item spam-use-BBDB)
2036           (variable-item spam-use-ifile)
2037           (variable-item spam-use-spamoracle)
2038           (variable-item spam-use-spamassassin)
2039           (variable-item spam-use-spamassassin-headers)
2040           (variable-item spam-use-stat)
2041           (variable-item spam-use-blackholes)
2042           (variable-item spam-use-hashcash)
2043           (variable-item spam-use-bogofilter-headers)
2044           (variable-item spam-use-bogofilter)))
2045    :function-document
2046    "Methods to be used for autodetection in each group"
2047    :variable gnus-spam-autodetect-methods
2048    :variable-default nil
2049    :variable-document
2050    "*Methods for autodetecting spam per group.
2051 Requires the spam-autodetect parameter.  Only unseen articles
2052 will be examined, unless spam-autodetect-recheck-messages is
2053 set."
2054    :variable-group spam
2055    :variable-type 
2056    '(repeat
2057      :tag "Autodetection methods"
2058      (list
2059       (regexp :tag "Group Regexp")
2060       (choice
2061        (const none)
2062        (const default)
2063        (set :tag "Use specific methods"
2064         (variable-item spam-use-blacklist)
2065         (variable-item spam-use-regex-headers)
2066         (variable-item spam-use-regex-body)
2067         (variable-item spam-use-whitelist)
2068         (variable-item spam-use-BBDB)
2069         (variable-item spam-use-ifile)
2070         (variable-item spam-use-spamoracle)
2071         (variable-item spam-use-stat)
2072         (variable-item spam-use-blackholes)
2073         (variable-item spam-use-hashcash)
2074         (variable-item spam-use-spamassassin)
2075         (variable-item spam-use-spamassassin-headers)
2076         (variable-item spam-use-bogofilter-headers)
2077         (variable-item spam-use-bogofilter)))))
2078      :parameter-document
2079    "Spam autodetection methods.  
2080 Requires the spam-autodetect parameter.  Only unseen articles
2081 will be examined, unless spam-autodetect-recheck-messages is
2082 set.")
2083
2084   (gnus-define-group-parameter
2085    spam-process-destination
2086    :type list
2087    :parameter-type 
2088    '(choice :tag "Destination for spam-processed articles at summary exit"
2089             (string :tag "Move to a group")
2090             (repeat :tag "Move to multiple groups"
2091                     (string :tag "Destination group"))
2092             (const :tag "Expire" nil))
2093    :function-document
2094    "Where spam-processed articles will go at summary exit."
2095    :variable gnus-spam-process-destinations
2096    :variable-default nil
2097    :variable-document
2098    "*Groups in which to explicitly send spam-processed articles to
2099 another group, or expire them (the default).  If non-nil, this should
2100 be a list of group name regexps that should match all groups in which
2101 to do spam-processed article moving, associated with the destination
2102 group or nil for explicit expiration.  This only makes sense for
2103 mail groups."
2104    :variable-group spam
2105    :variable-type 
2106    '(repeat
2107      :tag "Spam-processed articles destination"
2108      (list
2109       (regexp :tag "Group Regexp")
2110       (choice
2111        :tag "Destination for spam-processed articles at summary exit"
2112        (string :tag "Move to a group")
2113        (repeat :tag "Move to multiple groups"
2114                (string :tag "Destination group"))
2115        (const :tag "Expire" nil))))
2116    :parameter-document
2117    "Where spam-processed articles will go at summary exit.")
2118   
2119   (gnus-define-group-parameter
2120    ham-process-destination
2121    :type list
2122    :parameter-type 
2123    '(choice
2124      :tag "Destination for ham articles at summary exit from a spam group"
2125      (string :tag "Move to a group")
2126      (repeat :tag "Move to multiple groups"
2127              (string :tag "Destination group"))
2128      (const :tag "Respool" respool)
2129      (const :tag "Do nothing" nil))
2130    :function-document
2131    "Where ham articles will go at summary exit from a spam group."
2132    :variable gnus-ham-process-destinations
2133    :variable-default nil
2134    :variable-document
2135    "*Groups in which to explicitly send ham articles to
2136 another group, or do nothing (the default).  If non-nil, this should
2137 be a list of group name regexps that should match all groups in which
2138 to do ham article moving, associated with the destination
2139 group or nil for explicit ignoring.  This only makes sense for
2140 mail groups, and only works in spam groups."
2141    :variable-group spam
2142    :variable-type 
2143    '(repeat
2144      :tag "Ham articles destination"
2145      (list
2146       (regexp :tag "Group Regexp")
2147       (choice
2148        :tag "Destination for ham articles at summary exit from spam group"
2149        (string :tag "Move to a group")
2150        (repeat :tag "Move to multiple groups"
2151                 (string :tag "Destination group"))
2152        (const :tag "Respool" respool)
2153        (const :tag "Expire" nil))))
2154    :parameter-document
2155    "Where ham articles will go at summary exit from a spam group.")
2156
2157   (gnus-define-group-parameter
2158    ham-marks
2159    :type 'list
2160    :parameter-type '(list :tag "Ham mark choices"
2161                           (set
2162                            (variable-item gnus-del-mark)
2163                            (variable-item gnus-read-mark)
2164                            (variable-item gnus-ticked-mark)
2165                            (variable-item gnus-killed-mark)
2166                            (variable-item gnus-kill-file-mark)
2167                            (variable-item gnus-low-score-mark)))
2168
2169    :parameter-document
2170    "Marks considered ham (positively not spam).  Such articles will be
2171 processed as ham (non-spam) on group exit.  When nil, the global
2172 spam-ham-marks variable takes precedence."
2173    :variable-default '((".*" ((gnus-del-mark
2174                                gnus-read-mark
2175                                gnus-killed-mark
2176                                gnus-kill-file-mark
2177                                gnus-low-score-mark))))
2178    :variable-group spam
2179    :variable-document
2180    "*Groups in which to explicitly set the ham marks to some value.")
2181
2182   (gnus-define-group-parameter
2183    spam-marks
2184    :type 'list
2185    :parameter-type '(list :tag "Spam mark choices"
2186                           (set
2187                            (variable-item gnus-spam-mark)
2188                            (variable-item gnus-killed-mark)
2189                            (variable-item gnus-kill-file-mark)
2190                            (variable-item gnus-low-score-mark)))
2191
2192    :parameter-document
2193    "Marks considered spam.
2194 Such articles will be processed as spam on group exit.  When nil, the global
2195 spam-spam-marks variable takes precedence."
2196    :variable-default '((".*" ((gnus-spam-mark))))
2197    :variable-group spam
2198    :variable-document
2199    "*Groups in which to explicitly set the spam marks to some value."))
2200
2201 (defcustom gnus-group-uncollapsed-levels 1
2202   "Number of group name elements to leave alone when making a short group name."
2203   :group 'gnus-group-visual
2204   :type 'integer)
2205
2206 (defcustom gnus-group-use-permanent-levels nil
2207   "*If non-nil, once you set a level, Gnus will use this level."
2208   :group 'gnus-group-levels
2209   :type 'boolean)
2210
2211 ;; Hooks.
2212
2213 (defcustom gnus-load-hook nil
2214   "A hook run while Gnus is loaded."
2215   :group 'gnus-start
2216   :type 'hook)
2217
2218 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2219   "A hook called to apply kill files to a group.
2220 This hook is intended to apply a kill file to the selected newsgroup.
2221 The function `gnus-apply-kill-file' is called by default.
2222
2223 Since a general kill file is too heavy to use only for a few
2224 newsgroups, I recommend you to use a lighter hook function.  For
2225 example, if you'd like to apply a kill file to articles which contains
2226 a string `rmgroup' in subject in newsgroup `control', you can use the
2227 following hook:
2228
2229  (setq gnus-apply-kill-hook
2230       (list
2231         (lambda ()
2232           (cond ((string-match \"control\" gnus-newsgroup-name)
2233                  (gnus-kill \"Subject\" \"rmgroup\")
2234                  (gnus-expunge \"X\"))))))"
2235   :group 'gnus-score-kill
2236   :options '(gnus-apply-kill-file)
2237   :type 'hook)
2238
2239 (defcustom gnus-group-change-level-function nil
2240   "Function run when a group level is changed.
2241 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2242   :group 'gnus-group-levels
2243   :type 'function)
2244
2245 ;;; Face thingies.
2246
2247 (defcustom gnus-visual
2248   '(summary-highlight group-highlight article-highlight
2249                       mouse-face
2250                       summary-menu group-menu article-menu
2251                       tree-highlight menu highlight
2252                       browse-menu server-menu
2253                       page-marker tree-menu binary-menu pick-menu)
2254   "*Enable visual features.
2255 If `visual' is disabled, there will be no menus and few faces.  Most of
2256 the visual customization options below will be ignored.  Gnus will use
2257 less space and be faster as a result.
2258
2259 This variable can also be a list of visual elements to switch on.  For
2260 instance, to switch off all visual things except menus, you can say:
2261
2262    (setq gnus-visual '(menu))
2263
2264 Valid elements include `summary-highlight', `group-highlight',
2265 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2266 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2267 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2268   :group 'gnus-meta
2269   :group 'gnus-visual
2270   :type '(set (const summary-highlight)
2271               (const group-highlight)
2272               (const article-highlight)
2273               (const mouse-face)
2274               (const summary-menu)
2275               (const group-menu)
2276               (const article-menu)
2277               (const tree-highlight)
2278               (const menu)
2279               (const highlight)
2280               (const browse-menu)
2281               (const server-menu)
2282               (const page-marker)
2283               (const tree-menu)
2284               (const binary-menu)
2285               (const pick-menu)))
2286
2287 ;; Byte-compiler warning.
2288 (defvar gnus-visual)
2289 ;; Find out whether the gnus-visual TYPE is wanted.
2290 (defun gnus-visual-p (&optional type class)
2291   (and gnus-visual                      ; Has to be non-nil, at least.
2292        (if (not type)                   ; We don't care about type.
2293            gnus-visual
2294          (if (listp gnus-visual)        ; It's a list, so we check it.
2295              (or (memq type gnus-visual)
2296                  (memq class gnus-visual))
2297            t))))
2298
2299 (defcustom gnus-mouse-face
2300   (condition-case ()
2301       (if (gnus-visual-p 'mouse-face 'highlight)
2302           (if (boundp 'gnus-mouse-face)
2303               (or gnus-mouse-face 'highlight)
2304             'highlight)
2305         'default)
2306     (error 'highlight))
2307   "*Face used for group or summary buffer mouse highlighting.
2308 The line beneath the mouse pointer will be highlighted with this
2309 face."
2310   :group 'gnus-visual
2311   :type 'face)
2312
2313 (defcustom gnus-article-save-directory gnus-directory
2314   "*Name of the directory articles will be saved in (default \"~/News\")."
2315   :group 'gnus-article-saving
2316   :type 'directory)
2317
2318 (defvar gnus-plugged t
2319   "Whether Gnus is plugged or not.")
2320
2321 (defcustom gnus-agent-cache t
2322   "Controls use of the agent cache while plugged.
2323 When set, Gnus will prefer using the locally stored content rather
2324 than re-fetching it from the server.  You also need to enable
2325 `gnus-agent' for this to have any affect."
2326   :version "21.3"
2327   :group 'gnus-agent
2328   :type 'boolean)
2329
2330 (defcustom gnus-default-charset 'undecided
2331   "Default charset assumed to be used when viewing non-ASCII characters.
2332 This variable is overridden on a group-to-group basis by the
2333 `gnus-group-charset-alist' variable and is only used on groups not
2334 covered by that variable."
2335   :type 'symbol
2336   :group 'gnus-charset)
2337
2338 ;; Fixme: Doc reference to agent.
2339 (defcustom gnus-agent t
2340   "Whether we want to use the Gnus agent or not.
2341
2342 You may customize gnus-agent to disable its use.  However, some
2343 back ends have started to use the agent as a client-side cache.
2344 Disabling the agent may result in noticeable loss of performance."
2345   :version "21.3"
2346   :group 'gnus-agent
2347   :type 'boolean)
2348
2349 (defcustom gnus-other-frame-function 'gnus
2350   "Function called by the command `gnus-other-frame'."
2351   :group 'gnus-start
2352   :type '(choice (function-item gnus)
2353                  (function-item gnus-no-server)
2354                  (function-item gnus-slave)
2355                  (function-item gnus-slave-no-server)))
2356
2357 (defcustom gnus-other-frame-parameters nil
2358   "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2359 This should be an alist for Emacs, or a plist for XEmacs."
2360   :group 'gnus-start
2361   :type (if (featurep 'xemacs)
2362             '(repeat (list :inline t :format "%v"
2363                            (symbol :tag "Property")
2364                            (sexp :tag "Value")))
2365           '(repeat (cons :format "%v"
2366                          (symbol :tag "Parameter")
2367                          (sexp :tag "Value")))))
2368
2369 (defcustom gnus-user-agent 'gnus-mime-edit
2370   "Which information should be exposed in the User-Agent header.
2371
2372 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2373 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2374 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2375 `emacs-gnus' plus system type\), `gnus-mime-edit' \(show Gnus version and
2376 MIME Edit User-Agent\) or a custom string.  If you set it to a string,
2377 be sure to use a valid format, see RFC 2616."
2378   :group 'gnus-message
2379   :type '(choice
2380           (item :tag "Show Gnus version and MIME Edit User-Agent"
2381                 gnus-mime-edit)
2382           (item :tag "Show Gnus and Emacs versions and system type"
2383                 emacs-gnus-type)
2384           (item :tag "Show Gnus and Emacs versions and system configuration"
2385                 emacs-gnus-config)
2386           (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2387           (item :tag "Show only Gnus version" gnus)
2388           (string :tag "Other")))
2389
2390 \f
2391 ;;; Internal variables
2392
2393 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2394 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2395 (defvar gnus-agent-method-p-cache nil
2396   ; Reset each time gnus-agent-covered-methods is changed else
2397   ; gnus-agent-method-p may mis-report a methods status.
2398   )
2399 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2400 (defvar gnus-draft-meta-information-header "X-Draft-From")
2401 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2402 (defvar gnus-original-article-buffer " *Original Article*")
2403 (defvar gnus-newsgroup-name nil)
2404 (defvar gnus-ephemeral-servers nil)
2405 (defvar gnus-server-method-cache nil)
2406
2407 (defvar gnus-agent-fetching nil
2408   "Whether Gnus agent is in fetching mode.")
2409
2410 (defvar gnus-agent-covered-methods nil
2411   "A list of servers, NOT methods, showing which servers are covered by the agent.")
2412
2413 (defvar gnus-command-method nil
2414   "Dynamically bound variable that says what the current back end is.")
2415
2416 (defvar gnus-current-select-method nil
2417   "The current method for selecting a newsgroup.")
2418
2419 (defvar gnus-tree-buffer "*Tree*"
2420   "Buffer where Gnus thread trees are displayed.")
2421
2422 ;; Dummy variable.
2423 (defvar gnus-use-generic-from nil)
2424
2425 ;; Variable holding the user answers to all method prompts.
2426 (defvar gnus-method-history nil)
2427
2428 ;; Variable holding the user answers to all mail method prompts.
2429 (defvar gnus-mail-method-history nil)
2430
2431 ;; Variable holding the user answers to all group prompts.
2432 (defvar gnus-group-history nil)
2433
2434 (defvar gnus-server-alist nil
2435   "List of available servers.")
2436
2437 (defcustom gnus-cache-directory
2438   (nnheader-concat gnus-directory "cache/")
2439   "*The directory where cached articles will be stored."
2440   :group 'gnus-cache
2441   :type 'directory)
2442
2443 (defvar gnus-predefined-server-alist
2444   `(("cache"
2445      nnspool "cache"
2446      (nnspool-spool-directory ,gnus-cache-directory)
2447      (nnspool-nov-directory ,gnus-cache-directory)
2448      (nnspool-active-file
2449       ,(nnheader-concat gnus-cache-directory "active"))))
2450   "List of predefined (convenience) servers.")
2451
2452 (defvar gnus-topic-indentation "");; Obsolete variable.
2453
2454 (defconst gnus-article-mark-lists
2455   '((marked . tick) (replied . reply)
2456     (expirable . expire) (killed . killed)
2457     (bookmarks . bookmark) (dormant . dormant)
2458     (scored . score) (saved . save)
2459     (cached . cache) (downloadable . download)
2460     (unsendable . unsend) (forwarded . forward)
2461     (recent . recent) (seen . seen)))
2462
2463 (defconst gnus-article-special-mark-lists
2464   '((seen range)
2465     (killed range)
2466     (bookmark tuple)
2467     (score tuple)))
2468
2469 ;; Propagate flags to server, with the following exceptions:
2470 ;; `seen' is private to each gnus installation
2471 ;; `cache' is a internal gnus flag for each gnus installation
2472 ;; `download' is a agent flag private to each gnus installation
2473 ;; `unsend' are for nndraft groups only
2474 ;; `score' is not a proper mark
2475 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2476 (defconst gnus-article-unpropagated-mark-lists
2477   '(seen cache download unsend score bookmark)
2478   "Marks that shouldn't be propagated to back ends.
2479 Typical marks are those that make no sense in a standalone back end,
2480 such as a mark that says whether an article is stored in the cache
2481 \(which doesn't make sense in a standalone back end).")
2482
2483 (defvar gnus-headers-retrieved-by nil)
2484 (defvar gnus-article-reply nil)
2485 (defvar gnus-override-method nil)
2486 (defvar gnus-article-check-size nil)
2487 (defvar gnus-opened-servers nil)
2488
2489 (defvar gnus-current-kill-article nil)
2490
2491 (defvar gnus-have-read-active-file nil)
2492
2493 (defconst gnus-maintainer
2494   "semi-gnus-ja@meadowy.org (T-gnus Bugfixing Girls + Boys)"
2495   "The mail address of the T-gnus maintainers.")
2496
2497 (defcustom gnus-info-filename nil
2498   "*Controls language of gnus Info.
2499 If nil and current-language-environment is Japanese, go to gnus-ja.
2500 Otherwise go to corresponding Info.
2501 This variable can be nil, gnus or gnus-ja."
2502   :group 'gnus-start
2503   :type '(choice (const nil)
2504                  (const :tag "English" gnus)
2505                  (const :tag "Japanese" gnus-ja)))
2506
2507 (defvar gnus-info-nodes
2508   '((gnus-group-mode "Group Buffer")
2509     (gnus-summary-mode "Summary Buffer")
2510     (gnus-article-mode "Article Buffer")
2511     (gnus-server-mode "Server Buffer")
2512     (gnus-browse-mode "Browse Foreign Server")
2513     (gnus-tree-mode "Tree Display"))
2514   "Alist of major modes and related Info nodes.")
2515
2516 (defvar gnus-group-buffer "*Group*")
2517 (defvar gnus-summary-buffer "*Summary*")
2518 (defvar gnus-article-buffer "*Article*")
2519 (defvar gnus-server-buffer "*Server*")
2520
2521 (defvar gnus-slave nil
2522   "Whether this Gnus is a slave or not.")
2523
2524 (defvar gnus-batch-mode nil
2525   "Whether this Gnus is running in batch mode or not.")
2526
2527 (defvar gnus-variable-list
2528   '(gnus-newsrc-options gnus-newsrc-options-n
2529                         gnus-newsrc-last-checked-date
2530                         gnus-newsrc-alist gnus-server-alist
2531                         gnus-killed-list gnus-zombie-list
2532                         gnus-topic-topology gnus-topic-alist)
2533   "Gnus variables saved in the quick startup file.")
2534
2535 (defvar gnus-product-variable-file-list
2536   (let ((version (product-version (product-find 'gnus-vers))))
2537     `(("strict-cache"
2538        ((product-version ,version)
2539         (emacs-version)
2540         (correct-string-widths))
2541        binary
2542        gnus-format-specs-compiled)
2543       ("cache"
2544        ((product-version ,version)
2545         (emacs-version)
2546         (correct-string-widths))
2547        ctext
2548        gnus-format-specs)))
2549   "Alist of the methods for checking whether the contents of the T-gnus
2550 quick startup files are valid.  One is for the byte-compiled format
2551 specifications, the other is for the source form.  Each element should
2552 be a list which looks like follows:
2553
2554 \(\"FILE_NAME\"
2555  ((VARIABLE EXPECTED_VALUE_or_NIL)
2556   (VARIABLE EXPECTED_VALUE_or_NIL)
2557   ...)
2558  CODING-SYSTEM_FOR_READING_FILE
2559  SYMBOL_OF_FORMAT_SPECS)")
2560
2561 (defcustom gnus-compile-user-specs t
2562   "If non-nil, the user-defined format specs will be byte-compiled
2563 automatically.
2564 It has an effect on the values of `gnus-*-line-format-spec'."
2565   :group 'gnus
2566   :type 'boolean)
2567
2568 (defvar gnus-newsrc-alist nil
2569   "Assoc list of read articles.
2570 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2571
2572 (defvar gnus-registry-alist nil
2573   "Assoc list of registry data.
2574 gnus-registry.el will populate this if it's loaded.")
2575
2576 (defvar gnus-newsrc-hashtb nil
2577   "Hashtable of `gnus-newsrc-alist'.")
2578
2579 (defvar gnus-killed-list nil
2580   "List of killed newsgroups.")
2581
2582 (defvar gnus-killed-hashtb nil
2583   "Hash table equivalent of `gnus-killed-list'.")
2584
2585 (defvar gnus-zombie-list nil
2586   "List of almost dead newsgroups.")
2587
2588 (defvar gnus-description-hashtb nil
2589   "Descriptions of newsgroups.")
2590
2591 (defvar gnus-list-of-killed-groups nil
2592   "List of newsgroups that have recently been killed by the user.")
2593
2594 (defvar gnus-active-hashtb nil
2595   "Hashtable of active articles.")
2596
2597 (defvar gnus-moderated-hashtb nil
2598   "Hashtable of moderated newsgroups.")
2599
2600 ;; Save window configuration.
2601 (defvar gnus-prev-winconf nil)
2602
2603 (defvar gnus-reffed-article-number nil)
2604
2605 ;;; Let the byte-compiler know that we know about this variable.
2606 (defvar rmail-default-rmail-file)
2607
2608 (defvar gnus-dead-summary nil)
2609
2610 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2611   "Regexp matching invalid groups.")
2612
2613 (defvar gnus-other-frame-object nil
2614   "A frame object which will be created by `gnus-other-frame'.")
2615
2616 ;;; End of variables.
2617
2618 ;; Define some autoload functions Gnus might use.
2619 (eval-and-compile
2620
2621   ;; This little mapcar goes through the list below and marks the
2622   ;; symbols in question as autoloaded functions.
2623   (mapcar
2624    (lambda (package)
2625      (let ((interactive (nth 1 (memq ':interactive package))))
2626        (mapcar
2627         (lambda (function)
2628           (let (keymap)
2629             (when (consp function)
2630               (setq keymap (car (memq 'keymap function)))
2631               (setq function (car function)))
2632             (unless (fboundp function)
2633               (autoload function (car package) nil interactive keymap))))
2634         (if (eq (nth 1 package) ':interactive)
2635             (nthcdr 3 package)
2636           (cdr package)))))
2637    '(("info" :interactive t Info-goto-node)
2638      ("pp" pp-to-string)
2639      ("ps-print" ps-print-preprint)
2640      ("message" :interactive t
2641       message-send-and-exit message-yank-original)
2642      ("babel" babel-as-string)
2643      ("nnmail" nnmail-split-fancy nnmail-article-group)
2644      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2645      ("rmailout" rmail-output rmail-output-to-rmail-file)
2646      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2647       rmail-show-message rmail-summary-exists
2648       rmail-select-summary rmail-update-summary)
2649      ("gnus-audio" :interactive t gnus-audio-play)
2650      ("gnus-xmas" gnus-xmas-splash)
2651      ("gnus-soup" :interactive t
2652       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2653       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2654      ("nnsoup" nnsoup-pack-replies)
2655      ("score-mode" :interactive t gnus-score-mode)
2656      ("gnus-mh" gnus-summary-save-article-folder
2657       gnus-Folder-save-name gnus-folder-save-name)
2658      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2659      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2660       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2661       gnus-demon-add-disconnection gnus-demon-add-handler
2662       gnus-demon-remove-handler)
2663      ("gnus-demon" :interactive t
2664       gnus-demon-init gnus-demon-cancel)
2665      ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2666       gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2667       gnus-face-from-file)
2668      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2669       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2670      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2671       gnus-nocem-unwanted-article-p)
2672      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2673       gnus-server-server-name)
2674      ("gnus-srvr" gnus-browse-foreign-server)
2675      ("gnus-cite" :interactive t
2676       gnus-article-highlight-citation gnus-article-hide-citation-maybe
2677       gnus-article-hide-citation gnus-article-fill-cited-article
2678       gnus-article-hide-citation-in-followups)
2679      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2680       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2681       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2682      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2683       gnus-cache-possibly-remove-articles gnus-cache-request-article
2684       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2685       gnus-cache-enter-remove-article gnus-cached-article-p
2686       gnus-cache-open gnus-cache-close gnus-cache-update-article
2687       gnus-cache-articles-in-group)
2688      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2689       gnus-cache-remove-article gnus-summary-insert-cached-articles)
2690      ("gnus-score" :interactive t
2691       gnus-summary-increase-score gnus-summary-set-score
2692       gnus-summary-raise-thread gnus-summary-raise-same-subject
2693       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2694       gnus-summary-lower-thread gnus-summary-lower-same-subject
2695       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2696       gnus-summary-current-score gnus-score-delta-default
2697       gnus-score-flush-cache gnus-score-close
2698       gnus-possibly-score-headers gnus-score-followup-article
2699       gnus-score-followup-thread)
2700      ("gnus-score"
2701       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2702       gnus-current-score-file-nondirectory gnus-score-adaptive
2703       gnus-score-find-trace gnus-score-file-name)
2704      ("gnus-cus" :interactive t gnus-custom-mode gnus-group-customize
2705       gnus-score-customize)
2706      ("gnus-topic" :interactive t gnus-topic-mode)
2707      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2708       gnus-subscribe-topics)
2709      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2710      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2711      ("gnus-uu" :interactive t
2712       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2713       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2714       gnus-uu-mark-by-regexp gnus-uu-mark-all
2715       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2716       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2717       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2718       gnus-uu-decode-binhex gnus-uu-decode-uu-view
2719       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2720       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2721       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2722       gnus-uu-mark-over gnus-uu-post-news)
2723      ("gnus-uu" gnus-uu-delete-work-dir gnus-quote-arg-for-sh-or-csh
2724       gnus-uu-unmark-thread)
2725      ("gnus-msg" (gnus-summary-send-map keymap)
2726       gnus-article-mail gnus-copy-article-buffer gnus-following-method)
2727      ("gnus-msg" :interactive t
2728       gnus-group-post-news gnus-group-mail gnus-group-news
2729       gnus-summary-post-news gnus-summary-news-other-window
2730       gnus-summary-followup gnus-summary-followup-with-original
2731       gnus-summary-cancel-article gnus-summary-supersede-article
2732       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2733       gnus-summary-mail-forward gnus-summary-mail-other-window
2734       gnus-summary-resend-message gnus-summary-resend-bounced-mail
2735       gnus-summary-wide-reply gnus-summary-followup-to-mail
2736       gnus-summary-followup-to-mail-with-original gnus-bug
2737       gnus-summary-wide-reply-with-original gnus-summary-post-forward
2738       gnus-summary-digest-mail-forward gnus-summary-digest-post-forward)
2739      ("gnus-picon" :interactive t gnus-treat-from-picon)
2740      ("smiley" :interactive t smiley-region)
2741      ("gnus-win" gnus-configure-windows gnus-add-configuration)
2742      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2743       gnus-list-of-unread-articles gnus-list-of-read-articles
2744       gnus-offer-save-summaries gnus-make-thread-indent-array
2745       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2746       gnus-summary-skip-intangible gnus-summary-article-number
2747       gnus-data-header gnus-data-find gnus-summary-jump-to-other-group)
2748      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2749       gnus-group-list-groups gnus-group-first-unread-group
2750       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2751       gnus-group-setup-buffer gnus-group-get-new-news
2752       gnus-group-make-help-group gnus-group-update-group
2753       gnus-group-iterate gnus-group-group-name)
2754      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2755       gnus-backlog-remove-article)
2756      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2757       gnus-article-prepare gnus-article-set-window-start
2758       gnus-article-next-page gnus-article-prev-page
2759       gnus-request-article-this-buffer gnus-article-mode
2760       gnus-article-setup-buffer gnus-narrow-to-page
2761       gnus-article-delete-invisible-text gnus-treat-article)
2762      ("gnus-art" :interactive t
2763       gnus-article-hide-headers gnus-article-hide-boring-headers
2764       gnus-article-treat-overstrike
2765       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2766       gnus-article-display-x-face
2767       gnus-article-decode-HZ
2768       gnus-article-wash-html
2769       gnus-article-unsplit-urls
2770       gnus-article-hide-pem gnus-article-hide-signature
2771       gnus-article-strip-leading-blank-lines gnus-article-date-local
2772       gnus-article-date-original gnus-article-date-lapsed
2773       gnus-article-show-all-headers
2774       ;; gnus-article-show-all
2775       gnus-article-edit-mode gnus-article-edit-article
2776       gnus-article-edit-done article-decode-encoded-words
2777       gnus-start-date-timer gnus-stop-date-timer)
2778      ("gnus-int" gnus-request-type)
2779      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2780       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2781      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2782       gnus-dup-enter-articles)
2783      ("gnus-range" gnus-copy-sequence)
2784      ("gnus-eform" gnus-edit-form)
2785      ("gnus-move" :interactive t
2786       gnus-group-move-group-to-server gnus-change-server)
2787      ("gnus-logic" gnus-score-advanced)
2788      ("gnus-undo" gnus-undo-mode gnus-undo-register)
2789      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2790       gnus-async-prefetch-article gnus-async-prefetch-remove-group
2791       gnus-async-halt-prefetch)
2792      ("gnus-offline"
2793       gnus-offline-setup)
2794      ("gnus-offline" :interactive t
2795       gnus-offline-toggle-plugged
2796       gnus-offline-set-unplugged-state
2797       gnus-offline-toggle-auto-hangup
2798       gnus-offline-toggle-on/off-send-mail
2799       gnus-offline-toggle-articles-to-fetch
2800       gnus-offline-set-interval-time
2801       gnus-offline-agent-expire)
2802      ("miee" :interactive t gnspool-get-news
2803       mail-spool-send news-spool-post)
2804      ("international/mw32misc" define-process-argument-editing
2805       general-process-argument-editing-function)
2806      ("gnus-agent" gnus-open-agent gnus-agent-get-function
2807       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2808       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2809       gnus-summary-set-agent-mark gnus-agent-save-group-info
2810       gnus-agent-request-article gnus-agent-retrieve-headers)
2811      ("gnus-agent" :interactive t
2812       gnus-unplugged gnus-agentize gnus-agent-batch)
2813      ("gnus-vm" :interactive t gnus-summary-save-in-vm
2814       gnus-summary-save-article-vm)
2815      ("compface" uncompface)
2816      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2817      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2818      ("gnus-mlspl" :interactive t gnus-group-split-setup
2819       gnus-group-split-update)
2820      ("gnus-delay" gnus-delay-initialize))))
2821
2822 (eval-and-compile
2823   (unless (featurep 'xemacs)
2824     (autoload 'x-face-decode-message-header "x-face-e21")
2825     (autoload 'x-face-mule-gnus-article-display-x-face "x-face-mule")))
2826
2827 (unless (and (fboundp 'base64-encode-string)
2828              (subrp (symbol-function 'base64-encode-string)))
2829   (require 'base64))
2830
2831 ;; To search articles with Namazu.
2832 (autoload 'gnus-namazu-search "gnus-namazu" nil t)
2833 (autoload 'gnus-namazu-create-index "gnus-namazu" nil t)
2834 (autoload 'gnus-namazu-update-index "gnus-namazu" nil t)
2835 (autoload 'gnus-namazu-update-all-indices "gnus-namazu" nil t)
2836
2837 ;; To make nnir groups.
2838 (autoload 'gnus-group-make-nnir-group "nnir" nil t)
2839
2840 ;; To make shimbun groups.
2841 (autoload 'gnus-group-make-shimbun-group "nnshimbun" nil t)
2842
2843 ;;; gnus-sum.el thingies
2844
2845 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2846   "*The format specification of the lines in the summary buffer.
2847
2848 It works along the same lines as a normal formatting string,
2849 with some simple extensions.
2850
2851 %N   Article number, left padded with spaces (string)
2852 %S   Subject (string)
2853 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
2854 %n   Name of the poster (string)
2855 %a   Extracted name of the poster (string)
2856 %A   Extracted address of the poster (string)
2857 %F   Contents of the From: header (string)
2858 %f   Contents of the From: or To: headers (string)
2859 %x   Contents of the Xref: header (string)
2860 %D   Date of the article (string)
2861 %d   Date of the article (string) in DD-MMM format
2862 %o   Date of the article (string) in YYYYMMDD`T'HHMMSS format
2863 %M   Message-id of the article (string)
2864 %r   References of the article (string)
2865 %c   Number of characters in the article (integer)
2866 %k   Pretty-printed version of the above (string)
2867      For example, \"1.2k\" or \"0.4M\".
2868 %L   Number of lines in the article (integer)
2869 %I   Indentation based on thread level (a string of spaces)
2870 %B   A complex trn-style thread tree (string)
2871      The variables `gnus-sum-thread-*' can be used for customization.
2872 %T   A string with two possible values: 80 spaces if the article
2873      is on thread level two or larger and 0 spaces on level one
2874 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
2875 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2876 %[   Opening bracket (character, \"[\" or \"<\")
2877 %]   Closing bracket (character, \"]\" or \">\")
2878 %>   Spaces of length thread-level (string)
2879 %<   Spaces of length (- 20 thread-level) (string)
2880 %i   Article score (number)
2881 %z   Article zcore (character)
2882 %t   Number of articles under the current thread (number).
2883 %e   Whether the thread is empty or not (character).
2884 %l   GroupLens score (string).
2885 %V   Total thread score (number).
2886 %P   The line number (number).
2887 %O   Download mark (character).
2888 %*   If present, indicates desired cursor position
2889      (instead of after first colon).
2890 %u   User defined specifier.  The next character in the format string should
2891      be a letter.  Gnus will call the function gnus-user-format-function-X,
2892      where X is the letter following %u.  The function will be passed the
2893      current header as argument.  The function should return a string, which
2894      will be inserted into the summary just like information from any other
2895      summary specifier.
2896
2897 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2898 with care.  For reasons of efficiency, Gnus will compute what column
2899 these characters will end up in, and \"hard-code\" that.  This means that
2900 it is invalid to have these specs after a variable-length spec.  Well,
2901 you might not be arrested, but your summary buffer will look strange,
2902 which is bad enough.
2903
2904 The smart choice is to have these specs as far to the left as
2905 possible.
2906
2907 This restriction may disappear in later versions of Gnus.
2908
2909 General format specifiers can also be used.
2910 See Info node `(gnus)Formatting Variables'."
2911   :link '(custom-manual "(gnus)Formatting Variables")
2912   :type 'string
2913   :group 'gnus-summary-format)
2914
2915 ;;;
2916 ;;; Skeleton keymaps
2917 ;;;
2918
2919 (defun gnus-suppress-keymap (keymap)
2920   (suppress-keymap keymap)
2921   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2922     (while keys
2923       (define-key keymap (pop keys) 'undefined))))
2924
2925 (defvar gnus-article-mode-map
2926   (let ((keymap (make-sparse-keymap)))
2927     (gnus-suppress-keymap keymap)
2928     keymap))
2929 (defvar gnus-summary-mode-map
2930   (let ((keymap (make-keymap)))
2931     (gnus-suppress-keymap keymap)
2932     keymap))
2933 (defvar gnus-group-mode-map
2934   (let ((keymap (make-keymap)))
2935     (gnus-suppress-keymap keymap)
2936     keymap))
2937
2938 \f
2939
2940 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2941 ;; If you want the cursor to go somewhere else, set these two
2942 ;; functions in some startup hook to whatever you want.
2943 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2944 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2945
2946 ;;; Various macros and substs.
2947
2948 (defun gnus-header-from (header)
2949   (mail-header-from header))
2950
2951 (defmacro gnus-gethash (string hashtable)
2952   "Get hash value of STRING in HASHTABLE."
2953   `(symbol-value (intern-soft ,string ,hashtable)))
2954
2955 (defmacro gnus-gethash-safe (string hashtable)
2956   "Get hash value of STRING in HASHTABLE.
2957 Return nil if not defined."
2958   `(let ((sym (intern-soft ,string ,hashtable)))
2959      (and (boundp sym) (symbol-value sym))))
2960
2961 (defmacro gnus-sethash (string value hashtable)
2962   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
2963   `(set (intern ,string ,hashtable) ,value))
2964 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2965
2966 (defmacro gnus-group-unread (group)
2967   "Get the currently computed number of unread articles in GROUP."
2968   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2969
2970 (defmacro gnus-group-entry (group)
2971   "Get the newsrc entry for GROUP."
2972   `(gnus-gethash ,group gnus-newsrc-hashtb))
2973
2974 (defmacro gnus-active (group)
2975   "Get active info on GROUP."
2976   `(gnus-gethash ,group gnus-active-hashtb))
2977
2978 (defmacro gnus-set-active (group active)
2979   "Set GROUP's active info."
2980   `(gnus-sethash ,group ,active gnus-active-hashtb))
2981
2982 ;; Info access macros.
2983
2984 (defmacro gnus-info-group (info)
2985   `(nth 0 ,info))
2986 (defmacro gnus-info-rank (info)
2987   `(nth 1 ,info))
2988 (defmacro gnus-info-read (info)
2989   `(nth 2 ,info))
2990 (defmacro gnus-info-marks (info)
2991   `(nth 3 ,info))
2992 (defmacro gnus-info-method (info)
2993   `(nth 4 ,info))
2994 (defmacro gnus-info-params (info)
2995   `(nth 5 ,info))
2996
2997 (defmacro gnus-info-level (info)
2998   `(let ((rank (gnus-info-rank ,info)))
2999      (if (consp rank)
3000          (car rank)
3001        rank)))
3002 (defmacro gnus-info-score (info)
3003   `(let ((rank (gnus-info-rank ,info)))
3004      (or (and (consp rank) (cdr rank)) 0)))
3005
3006 (defmacro gnus-info-set-group (info group)
3007   `(setcar ,info ,group))
3008 (defmacro gnus-info-set-rank (info rank)
3009   `(setcar (nthcdr 1 ,info) ,rank))
3010 (defmacro gnus-info-set-read (info read)
3011   `(setcar (nthcdr 2 ,info) ,read))
3012 (defmacro gnus-info-set-marks (info marks &optional extend)
3013   (if extend
3014       `(gnus-info-set-entry ,info ,marks 3)
3015     `(setcar (nthcdr 3 ,info) ,marks)))
3016 (defmacro gnus-info-set-method (info method &optional extend)
3017   (if extend
3018       `(gnus-info-set-entry ,info ,method 4)
3019     `(setcar (nthcdr 4 ,info) ,method)))
3020 (defmacro gnus-info-set-params (info params &optional extend)
3021   (if extend
3022       `(gnus-info-set-entry ,info ,params 5)
3023     `(setcar (nthcdr 5 ,info) ,params)))
3024
3025 (defun gnus-info-set-entry (info entry number)
3026   ;; Extend the info until we have enough elements.
3027   (while (<= (length info) number)
3028     (nconc info (list nil)))
3029   ;; Set the entry.
3030   (setcar (nthcdr number info) entry))
3031
3032 (defmacro gnus-info-set-level (info level)
3033   `(let ((rank (cdr ,info)))
3034      (if (consp (car rank))
3035          (setcar (car rank) ,level)
3036        (setcar rank ,level))))
3037 (defmacro gnus-info-set-score (info score)
3038   `(let ((rank (cdr ,info)))
3039      (if (consp (car rank))
3040          (setcdr (car rank) ,score)
3041        (setcar rank (cons (car rank) ,score)))))
3042
3043 (defmacro gnus-get-info (group)
3044   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
3045
3046 ;;; Load the compatibility functions.
3047
3048 (require 'gnus-ems)
3049
3050 \f
3051 ;;;
3052 ;;; Shutdown
3053 ;;;
3054
3055 (defvar gnus-shutdown-alist nil)
3056
3057 (defun gnus-add-shutdown (function &rest symbols)
3058   "Run FUNCTION whenever one of SYMBOLS is shut down."
3059   (push (cons function symbols) gnus-shutdown-alist))
3060
3061 (defun gnus-shutdown (symbol)
3062   "Shut down everything that waits for SYMBOL."
3063   (let ((alist gnus-shutdown-alist)
3064         entry)
3065     (while (setq entry (pop alist))
3066       (when (memq symbol (cdr entry))
3067         (funcall (car entry))))))
3068
3069 \f
3070 ;;;
3071 ;;; Gnus Utility Functions
3072 ;;;
3073
3074 (defun gnus-find-subscribed-addresses ()
3075   "Return a regexp matching the addresses of all subscribed mail groups.
3076 It consists of the `to-address' or `to-list' parameter of all groups
3077 with a `subscribed' parameter."
3078   (let (group address addresses)
3079     (dolist (entry (cdr gnus-newsrc-alist))
3080       (setq group (car entry))
3081       (when (gnus-parameter-subscribed group)
3082         (setq address (mail-strip-quoted-names
3083                        (or (gnus-group-fast-parameter group 'to-address)
3084                            (gnus-group-fast-parameter group 'to-list))))
3085         (when address
3086           (add-to-list 'addresses address))))
3087     (when addresses
3088       (list (mapconcat 'regexp-quote addresses "\\|")))))
3089
3090 (defmacro gnus-string-or (&rest strings)
3091   "Return the first element of STRINGS that is a non-blank string.
3092 STRINGS will be evaluated in normal `or' order."
3093   `(gnus-string-or-1 ',strings))
3094
3095 (defun gnus-string-or-1 (strings)
3096   (let (string)
3097     (while strings
3098       (setq string (eval (pop strings)))
3099       (if (string-match "^[ \t]*$" string)
3100           (setq string nil)
3101         (setq strings nil)))
3102     string))
3103
3104 (defun gnus-info-find-node (&optional nodename)
3105   "Find Info documentation of Gnus."
3106   (interactive)
3107   ;; Enlarge info window if needed.
3108   (let (gnus-info-buffer)
3109     (Info-goto-node
3110      (format "(%s)%s"
3111              (or gnus-info-filename
3112                  (get-language-info current-language-environment 'gnus-info)
3113                  "gnus")
3114              (or nodename
3115                  (cadr (assq major-mode gnus-info-nodes))
3116                  (and (eq (current-buffer) (get-buffer gnus-article-buffer))
3117                       (cadr (assq 'gnus-article-mode gnus-info-nodes))))))
3118     (setq gnus-info-buffer (current-buffer))
3119     (gnus-configure-windows 'info)))
3120
3121 ;;;
3122 ;;; gnus-interactive
3123 ;;;
3124
3125 (defvar gnus-current-prefix-symbol nil
3126   "Current prefix symbol.")
3127
3128 (defvar gnus-current-prefix-symbols nil
3129   "List of current prefix symbols.")
3130
3131 (defun gnus-interactive (string &optional params)
3132   "Return a list that can be fed to `interactive'.
3133 See `interactive' for full documentation.
3134
3135 Adds the following specs:
3136
3137 y -- The current symbolic prefix.
3138 Y -- A list of the current symbolic prefix(es).
3139 A -- Article number.
3140 H -- Article header.
3141 g -- Group name."
3142   (let ((i 0)
3143         out c prompt)
3144     (while (< i (length string))
3145       (string-match ".\\([^\n]*\\)\n?" string i)
3146       (setq c (aref string i))
3147       (when (match-end 1)
3148         (setq prompt (match-string 1 string)))
3149       (setq i (match-end 0))
3150       ;; We basically emulate just about everything that
3151       ;; `interactive' does, but add the specs listed above.
3152       (push
3153        (cond
3154         ((= c ?a)
3155          (completing-read prompt obarray 'fboundp t))
3156         ((= c ?b)
3157          (read-buffer prompt (current-buffer) t))
3158         ((= c ?B)
3159          (read-buffer prompt (other-buffer (current-buffer))))
3160         ((= c ?c)
3161          (read-char))
3162         ((= c ?C)
3163          (completing-read prompt obarray 'commandp t))
3164         ((= c ?d)
3165          (point))
3166         ((= c ?D)
3167          (read-file-name prompt nil default-directory 'lambda))
3168         ((= c ?f)
3169          (read-file-name prompt nil nil 'lambda))
3170         ((= c ?F)
3171          (read-file-name prompt))
3172         ((= c ?k)
3173          (read-key-sequence prompt))
3174         ((= c ?K)
3175          (error "Not implemented spec"))
3176         ((= c ?e)
3177          (error "Not implemented spec"))
3178         ((= c ?m)
3179          (mark))
3180         ((= c ?N)
3181          (error "Not implemented spec"))
3182         ((= c ?n)
3183          (string-to-number (read-from-minibuffer prompt)))
3184         ((= c ?p)
3185          (prefix-numeric-value current-prefix-arg))
3186         ((= c ?P)
3187          current-prefix-arg)
3188         ((= c ?r)
3189          'gnus-prefix-nil)
3190         ((= c ?s)
3191          (read-string prompt))
3192         ((= c ?S)
3193          (intern (read-string prompt)))
3194         ((= c ?v)
3195          (read-variable prompt))
3196         ((= c ?x)
3197          (read-minibuffer prompt))
3198         ((= c ?x)
3199          (eval-minibuffer prompt))
3200         ;; And here the new specs come.
3201         ((= c ?y)
3202          gnus-current-prefix-symbol)
3203         ((= c ?Y)
3204          gnus-current-prefix-symbols)
3205         ((= c ?g)
3206          (gnus-group-group-name))
3207         ((= c ?A)
3208          (gnus-summary-skip-intangible)
3209          (or (get-text-property (point) 'gnus-number)
3210              (gnus-summary-last-subject)))
3211         ((= c ?H)
3212          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3213         (t
3214          (error "Non-implemented spec")))
3215        out)
3216       (cond
3217        ((= c ?r)
3218         (push (if (< (point) (mark)) (point) (mark)) out)
3219         (push (if (> (point) (mark)) (point) (mark)) out))))
3220     (setq out (delq 'gnus-prefix-nil out))
3221     (nreverse out)))
3222
3223 (defun gnus-symbolic-argument (&optional arg)
3224   "Read a symbolic argument and a command, and then execute command."
3225   (interactive "P")
3226   (let* ((in-command (this-command-keys))
3227          (command in-command)
3228          gnus-current-prefix-symbols
3229          gnus-current-prefix-symbol
3230          syms)
3231     (while (equal in-command command)
3232       (message "%s-" (key-description (this-command-keys)))
3233       (push (intern (char-to-string (read-char))) syms)
3234       (setq command (read-key-sequence nil t)))
3235     (setq gnus-current-prefix-symbols (nreverse syms)
3236           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3237     (call-interactively (key-binding command t))))
3238
3239 ;;; More various functions.
3240
3241 (defsubst gnus-check-backend-function (func group)
3242   "Check whether GROUP supports function FUNC.
3243 GROUP can either be a string (a group name) or a select method."
3244   (ignore-errors
3245     (let ((method (if (stringp group)
3246                       (car (gnus-find-method-for-group group))
3247                     group)))
3248       (unless (featurep method)
3249         (require method))
3250       (fboundp (intern (format "%s-%s" method func))))))
3251
3252 (defun gnus-group-read-only-p (&optional group)
3253   "Check whether GROUP supports editing or not.
3254 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
3255 that that variable is buffer-local to the summary buffers."
3256   (let ((group (or group gnus-newsgroup-name)))
3257     (not (gnus-check-backend-function 'request-replace-article group))))
3258
3259 (defun gnus-virtual-group-p (group)
3260   "Say whether GROUP is virtual or not."
3261   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3262                         gnus-valid-select-methods)))
3263
3264 (defun gnus-news-group-p (group &optional article)
3265   "Return non-nil if GROUP (and ARTICLE) come from a news server."
3266   (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3267          t)                             ;is news of course.
3268         ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3269          nil)                           ;must be mail then.
3270         ((vectorp article)              ;Has header info.
3271          (eq (gnus-request-type group (mail-header-id article)) 'news))
3272         ((null article)                 ;Hasn't header info
3273          (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3274         ((< article 0)                  ;Virtual message
3275          nil)                           ;we don't know, guess mail.
3276         (t                              ;Has positive number
3277          (eq (gnus-request-type group article) 'news)))) ;use it.
3278
3279 ;; Returns a list of writable groups.
3280 (defun gnus-writable-groups ()
3281   (let ((alist gnus-newsrc-alist)
3282         groups group)
3283     (while (setq group (car (pop alist)))
3284       (unless (gnus-group-read-only-p group)
3285         (push group groups)))
3286     (nreverse groups)))
3287
3288 ;; Check whether to use long file names.
3289 (defun gnus-use-long-file-name (symbol)
3290   ;; The variable has to be set...
3291   (and gnus-use-long-file-name
3292        ;; If it isn't a list, then we return t.
3293        (or (not (listp gnus-use-long-file-name))
3294            ;; If it is a list, and the list contains `symbol', we
3295            ;; return nil.
3296            (not (memq symbol gnus-use-long-file-name)))))
3297
3298 ;; Generate a unique new group name.
3299 (defun gnus-generate-new-group-name (leaf)
3300   (let ((name leaf)
3301         (num 0))
3302     (while (gnus-group-entry name)
3303       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3304     name))
3305
3306 (defun gnus-ephemeral-group-p (group)
3307   "Say whether GROUP is ephemeral or not."
3308   (gnus-group-get-parameter group 'quit-config t))
3309
3310 (defun gnus-group-quit-config (group)
3311   "Return the quit-config of GROUP."
3312   (gnus-group-get-parameter group 'quit-config t))
3313
3314 (defun gnus-kill-ephemeral-group (group)
3315   "Remove ephemeral GROUP from relevant structures."
3316   (gnus-sethash group nil gnus-newsrc-hashtb))
3317
3318 (defun gnus-simplify-mode-line ()
3319   "Make mode lines a bit simpler."
3320   (setq mode-line-modified (cdr gnus-mode-line-modified))
3321   (when (listp mode-line-format)
3322     (make-local-variable 'mode-line-format)
3323     (setq mode-line-format (copy-sequence mode-line-format))
3324     (when (equal (nth 3 mode-line-format) "   ")
3325       (setcar (nthcdr 3 mode-line-format) " "))))
3326
3327 ;;; Servers and groups.
3328
3329 (defsubst gnus-server-add-address (method)
3330   (let ((method-name (symbol-name (car method))))
3331     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3332              (not (assq (intern (concat method-name "-address")) method))
3333              (memq 'physical-address (assq (car method)
3334                                            gnus-valid-select-methods)))
3335         (append method (list (list (intern (concat method-name "-address"))
3336                                    (nth 1 method))))
3337       method)))
3338
3339 (defsubst gnus-server-to-method (server)
3340   "Map virtual server names to select methods."
3341   (or (and server (listp server) server)
3342       (cdr (assoc server gnus-server-method-cache))
3343       (let ((result
3344              (or
3345               ;; Perhaps this is the native server?
3346               (and (equal server "native") gnus-select-method)
3347               ;; It should be in the server alist.
3348               (cdr (assoc server gnus-server-alist))
3349               ;; It could be in the predefined server alist.
3350               (cdr (assoc server gnus-predefined-server-alist))
3351               ;; If not, we look through all the opened server
3352               ;; to see whether we can find it there.
3353               (let ((opened gnus-opened-servers))
3354                 (while (and opened
3355                             (not (equal server (format "%s:%s" (caaar opened)
3356                                                        (cadaar opened)))))
3357                   (pop opened))
3358                 (caar opened))
3359               ;; It could be a named method, search all servers
3360               (let ((servers gnus-secondary-select-methods))
3361                 (while (and servers
3362                             (not (equal server (format "%s:%s" (caar servers)
3363                                                        (cadar servers)))))
3364                   (pop servers))
3365                 (car servers))
3366               ;; This could be some sort of foreign server that I
3367               ;; simply haven't opened (yet).  Do a brute-force scan
3368               ;; of the entire gnus-newsrc-alist for the server name
3369               ;; of every method.  As a side-effect, loads the
3370               ;; gnus-server-method-cache so this only happens once,
3371               ;; if at all.
3372               (let (match)
3373                 (mapcar 
3374                  (lambda (info)
3375                    (let ((info-method (gnus-info-method info)))
3376                      (unless (stringp info-method)
3377                        (let ((info-server (gnus-method-to-server info-method)))
3378                          (when (equal server info-server)
3379                            (setq match info-method))))))
3380                  (cdr gnus-newsrc-alist))
3381                 match))))
3382         (when result
3383           (push (cons server result) gnus-server-method-cache))
3384         result)))
3385
3386 (defsubst gnus-method-to-server (method)
3387   (catch 'server-name
3388     (setq method (or method gnus-select-method))
3389
3390     ;; Perhaps it is already in the cache.
3391     (mapc (lambda (name-method)
3392             (if (equal (cdr name-method) method)
3393                 (throw 'server-name (car name-method))))
3394           gnus-server-method-cache)
3395
3396     (mapc
3397      (lambda (server-alist)
3398        (mapc (lambda (name-method)
3399                (when (gnus-methods-equal-p (cdr name-method) method)
3400                  (unless (member name-method gnus-server-method-cache)
3401                    (push name-method gnus-server-method-cache))
3402                  (throw 'server-name (car name-method))))
3403              server-alist))
3404      (let ((alists (list gnus-server-alist
3405                          gnus-predefined-server-alist)))
3406        (if gnus-select-method
3407            (push (list (cons "native" gnus-select-method)) alists))
3408        alists))
3409
3410     (let* ((name (if (member (cadr method) '(nil ""))
3411                      (format "%s" (car method))
3412                    (format "%s:%s" (car method) (cadr method))))
3413            (name-method (cons name method)))
3414       (unless (member name-method gnus-server-method-cache)
3415         (push name-method gnus-server-method-cache))
3416       name)))
3417
3418 (defsubst gnus-server-get-method (group method)
3419   ;; Input either a server name, and extended server name, or a
3420   ;; select method, and return a select method.
3421   (cond ((stringp method)
3422          (gnus-server-to-method method))
3423         ((equal method gnus-select-method)
3424          gnus-select-method)
3425         ((and (stringp (car method))
3426               group)
3427          (gnus-server-extend-method group method))
3428         ((and method
3429               (not group)
3430               (equal (cadr method) ""))
3431          method)
3432         (t
3433          (gnus-server-add-address method))))
3434
3435 (defmacro gnus-method-equal (ss1 ss2)
3436   "Say whether two servers are equal."
3437   `(let ((s1 ,ss1)
3438          (s2 ,ss2))
3439      (or (equal s1 s2)
3440          (and (= (length s1) (length s2))
3441               (progn
3442                 (while (and s1 (member (car s1) s2))
3443                   (setq s1 (cdr s1)))
3444                 (null s1))))))
3445
3446 (defun gnus-methods-equal-p (m1 m2)
3447   (let ((m1 (or m1 gnus-select-method))
3448         (m2 (or m2 gnus-select-method)))
3449     (or (equal m1 m2)
3450         (and (eq (car m1) (car m2))
3451              (or (not (memq 'address (assoc (symbol-name (car m1))
3452                                             gnus-valid-select-methods)))
3453                  (equal (nth 1 m1) (nth 1 m2)))))))
3454
3455 (defun gnus-server-equal (m1 m2)
3456   "Say whether two methods are equal."
3457   (let ((m1 (cond ((null m1) gnus-select-method)
3458                   ((stringp m1) (gnus-server-to-method m1))
3459                   (t m1)))
3460         (m2 (cond ((null m2) gnus-select-method)
3461                   ((stringp m2) (gnus-server-to-method m2))
3462                   (t m2))))
3463     (gnus-method-equal m1 m2)))
3464
3465 (defun gnus-servers-using-backend (backend)
3466   "Return a list of known servers using BACKEND."
3467   (let ((opened gnus-opened-servers)
3468         out)
3469     (while opened
3470       (when (eq backend (caaar opened))
3471         (push (caar opened) out))
3472       (pop opened))
3473     out))
3474
3475 (defun gnus-archive-server-wanted-p ()
3476   "Say whether the user wants to use the archive server."
3477   (cond
3478    ((or (not gnus-message-archive-method)
3479         (not gnus-message-archive-group))
3480     nil)
3481    ((and gnus-message-archive-method gnus-message-archive-group)
3482     t)
3483    (t
3484     (let ((active (cadr (assq 'nnfolder-active-file
3485                               gnus-message-archive-method))))
3486       (and active
3487            (file-exists-p active))))))
3488
3489 (defsubst gnus-method-to-server-name (method)
3490   (concat
3491    (format "%s" (car method))
3492    (when (and
3493           (or (assoc (format "%s" (car method))
3494                      (gnus-methods-using 'address))
3495               (gnus-server-equal method gnus-message-archive-method))
3496           (nth 1 method)
3497           (not (string= (nth 1 method) "")))
3498      (concat "+" (nth 1 method)))))
3499
3500 (defsubst gnus-method-to-full-server-name (method)
3501   (format "%s+%s" (car method) (nth 1 method)))
3502
3503 (defun gnus-group-prefixed-name (group method &optional full)
3504   "Return the whole name from GROUP and METHOD.
3505 Call with full set to get the fully qualified group name (even if the
3506 server is native)."
3507   (when (stringp method)
3508     (setq method (gnus-server-to-method method)))
3509   (if (or (not method)
3510           (and (not full) (gnus-server-equal method "native"))
3511           ;;;!!! This might not be right.  We'll see...
3512           ;(string-match ":" group)
3513           )
3514       group
3515     (concat (gnus-method-to-server-name method) ":" group)))
3516
3517 (defun gnus-group-guess-prefixed-name (group)
3518   "Guess the whole name from GROUP and METHOD."
3519   (gnus-group-prefixed-name group (gnus-find-method-for-group
3520                                group)))
3521
3522 (defun gnus-group-full-name (group method)
3523   "Return the full name from GROUP and METHOD, even if the method is native."
3524   (gnus-group-prefixed-name group method t))
3525
3526 (defun gnus-group-guess-full-name (group)
3527   "Guess the full name from GROUP, even if the method is native."
3528   (if (gnus-group-prefixed-p group)
3529       group
3530     (gnus-group-full-name group (gnus-find-method-for-group group))))
3531
3532 (defun gnus-group-guess-full-name-from-command-method (group)
3533   "Guess the full name from GROUP, even if the method is native."
3534   (if (gnus-group-prefixed-p group)
3535       group
3536     (gnus-group-full-name group gnus-command-method)))
3537
3538 (defun gnus-group-real-prefix (group)
3539   "Return the prefix of the current group name."
3540   (if (stringp group)
3541       (if (string-match "^[^:]+:" group)
3542           (substring group 0 (match-end 0))
3543         "")
3544     nil))
3545
3546 (defun gnus-group-short-name (group)
3547   "Return the short group name."
3548   (let ((prefix (gnus-group-real-prefix group)))
3549     (if (< 0 (length prefix))
3550         (substring group (length prefix) nil)
3551       group)))
3552
3553 (defun gnus-group-prefixed-p (group)
3554   "Return the prefix of the current group name."
3555   (< 0 (length (gnus-group-real-prefix group))))
3556
3557 (defun gnus-summary-buffer-name (group)
3558   "Return the summary buffer name of GROUP."
3559   (concat "*Summary " (gnus-group-decoded-name group) "*"))
3560
3561 (defun gnus-group-method (group)
3562   "Return the server or method used for selecting GROUP.
3563 You should probably use `gnus-find-method-for-group' instead."
3564   (let ((prefix (gnus-group-real-prefix group)))
3565     (if (equal prefix "")
3566         gnus-select-method
3567       (let ((servers gnus-opened-servers)
3568             (server "")
3569             backend possible found)
3570         (if (string-match "^[^\\+]+\\+" prefix)
3571             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3572                   server (substring prefix (match-end 0) (1- (length prefix))))
3573           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3574         (while servers
3575           (when (eq (caaar servers) backend)
3576             (setq possible (caar servers))
3577             (when (equal (cadaar servers) server)
3578               (setq found (caar servers))))
3579           (pop servers))
3580         (or (car (rassoc found gnus-server-alist))
3581             found
3582             (car (rassoc possible gnus-server-alist))
3583             possible
3584             (list backend server))))))
3585
3586 (defsubst gnus-native-method-p (method)
3587   "Return whether METHOD is the native select method."
3588   (gnus-method-equal method gnus-select-method))
3589
3590 (defsubst gnus-secondary-method-p (method)
3591   "Return whether METHOD is a secondary select method."
3592   (let ((methods gnus-secondary-select-methods)
3593         (gmethod (inline (gnus-server-get-method nil method))))
3594     (while (and methods
3595                 (not (gnus-method-equal
3596                       (inline (gnus-server-get-method nil (car methods)))
3597                       gmethod)))
3598       (setq methods (cdr methods)))
3599     methods))
3600
3601 (defun gnus-method-simplify (method)
3602   "Return the shortest uniquely identifying string or method for METHOD."
3603   (cond ((stringp method)
3604          method)
3605         ((gnus-native-method-p method)
3606          nil)
3607         ((gnus-secondary-method-p method)
3608          (format "%s:%s" (nth 0 method) (nth 1 method)))
3609         (t
3610          method)))
3611
3612 (defun gnus-groups-from-server (server)
3613   "Return a list of all groups that are fetched from SERVER."
3614   (let ((alist (cdr gnus-newsrc-alist))
3615         info groups)
3616     (while (setq info (pop alist))
3617       (when (gnus-server-equal (gnus-info-method info) server)
3618         (push (gnus-info-group info) groups)))
3619     (sort groups 'string<)))
3620
3621 (defun gnus-group-foreign-p (group)
3622   "Say whether a group is foreign or not."
3623   (and (not (gnus-group-native-p group))
3624        (not (gnus-group-secondary-p group))))
3625
3626 (defun gnus-group-native-p (group)
3627   "Say whether the group is native or not."
3628   (not (string-match ":" group)))
3629
3630 (defun gnus-group-secondary-p (group)
3631   "Say whether the group is secondary or not."
3632   (gnus-secondary-method-p (gnus-find-method-for-group group)))
3633
3634 (defun gnus-parameters-get-parameter (group)
3635   "Return the group parameters for GROUP from `gnus-parameters'."
3636   (let (params-list)
3637     (dolist (elem gnus-parameters)
3638       (when (string-match (car elem) group)
3639         (setq params-list
3640               (nconc (gnus-expand-group-parameters
3641                       (car elem) (cdr elem) group)
3642                      params-list))))
3643     params-list))
3644
3645 (defun gnus-expand-group-parameter (match value group)
3646   "Use MATCH to expand VALUE in GROUP."
3647   (with-temp-buffer
3648     (insert group)
3649     (goto-char (point-min))
3650     (while (re-search-forward match nil t)
3651       (replace-match value))
3652     (buffer-string)))
3653
3654 (defun gnus-expand-group-parameters (match parameters group)
3655   "Go through PARAMETERS and expand them according to the match data."
3656   (let (new)
3657     (dolist (elem parameters)
3658       (if (and (stringp (cdr elem))
3659                (string-match "\\\\[0-9&]" (cdr elem)))
3660           (push (cons (car elem)
3661                       (gnus-expand-group-parameter match (cdr elem) group))
3662                 new)
3663         (push elem new)))
3664     new))
3665
3666 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3667   "For GROUP, return the value of SYMBOL.
3668
3669 You should call this in the `gnus-group-buffer' buffer.
3670 The function `gnus-group-find-parameter' will do that for you."
3671   ;; The speed trick:  No cons'ing and quit early.
3672   (let* ((params (funcall gnus-group-get-parameter-function group))
3673          ;; Start easy, check the "real" group parameters.
3674          (simple-results
3675           (gnus-group-parameter-value params symbol allow-list t)))
3676     (if simple-results
3677         ;; Found results; return them.
3678         (car simple-results)
3679       ;; We didn't found it there, try `gnus-parameters'.
3680       (let ((result nil)
3681             (head nil)
3682             (tail gnus-parameters))
3683         ;; A good old-fashioned non-cl loop.
3684         (while tail
3685           (setq head (car tail)
3686                 tail (cdr tail))
3687           ;; The car is regexp matching for matching the group name.
3688           (when (string-match (car head) group)
3689             ;; The cdr is the parameters.
3690             (setq result (gnus-group-parameter-value (cdr head)
3691                                                      symbol allow-list))
3692             (when result
3693               ;; Expand if necessary.
3694               (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3695                   (setq result (gnus-expand-group-parameter (car head)
3696                                                             result group)))
3697               ;; Exit the loop early.
3698               (setq tail nil))))
3699         ;; Done.
3700         result))))
3701
3702 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3703   "Return the group parameters for GROUP.
3704 If SYMBOL, return the value of that symbol in the group parameters.
3705
3706 If you call this function inside a loop, consider using the faster
3707 `gnus-group-fast-parameter' instead."
3708   (save-excursion
3709     (set-buffer gnus-group-buffer)
3710     (if symbol
3711         (gnus-group-fast-parameter group symbol allow-list)
3712       (nconc
3713        (copy-sequence
3714         (funcall gnus-group-get-parameter-function group))
3715        (gnus-parameters-get-parameter group)))))
3716
3717 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3718   "Return the group parameters for GROUP.
3719 If SYMBOL, return the value of that symbol in the group parameters.
3720 Most functions should use `gnus-group-find-parameter', which
3721 also examines the topic parameters."
3722   (let ((params (gnus-info-params (gnus-get-info group))))
3723     (if symbol
3724         (gnus-group-parameter-value params symbol allow-list)
3725       params)))
3726
3727 (defun gnus-group-parameter-value (params symbol &optional
3728                                           allow-list present-p)
3729   "Return the value of SYMBOL in group PARAMS."
3730   ;; We only wish to return group parameters (dotted lists) and
3731   ;; not local variables, which may have the same names.
3732   ;; But first we handle single elements...
3733   (or (car (memq symbol params))
3734       ;; Handle alist.
3735       (let (elem)
3736         (catch 'found
3737           (while (setq elem (pop params))
3738             (when (and (consp elem)
3739                        (eq (car elem) symbol)
3740                        (or allow-list
3741                            (atom (cdr elem))))
3742               (throw 'found (if present-p (list (cdr elem))
3743                               (cdr elem)))))))))
3744
3745 (defun gnus-group-add-parameter (group param)
3746   "Add parameter PARAM to GROUP."
3747   (let ((info (gnus-get-info group)))
3748     (when info
3749       (gnus-group-remove-parameter group (if (consp param) (car param) param))
3750       ;; Cons the new param to the old one and update.
3751       (gnus-group-set-info (cons param (gnus-info-params info))
3752                            group 'params))))
3753
3754 (defun gnus-group-set-parameter (group name value)
3755   "Set parameter NAME to VALUE in GROUP."
3756   (let ((info (gnus-get-info group)))
3757     (when info
3758       (gnus-group-remove-parameter group name)
3759       (let ((old-params (gnus-info-params info))
3760             (new-params (list (cons name value))))
3761         (while old-params
3762           (when (or (not (listp (car old-params)))
3763                     (not (eq (caar old-params) name)))
3764             (setq new-params (append new-params (list (car old-params)))))
3765           (setq old-params (cdr old-params)))
3766         (gnus-group-set-info new-params group 'params)))))
3767
3768 (defun gnus-group-remove-parameter (group name)
3769   "Remove parameter NAME from GROUP."
3770   (let ((info (gnus-get-info group)))
3771     (when info
3772       (let ((params (gnus-info-params info)))
3773         (when params
3774           (setq params (delq name params))
3775           (while (assq name params)
3776             (gnus-pull name params))
3777           (gnus-info-set-params info params))))))
3778
3779 (defun gnus-group-add-score (group &optional score)
3780   "Add SCORE to the GROUP score.
3781 If SCORE is nil, add 1 to the score of GROUP."
3782   (let ((info (gnus-get-info group)))
3783     (when info
3784       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3785
3786 (defun gnus-short-group-name (group &optional levels)
3787   "Collapse GROUP name LEVELS.
3788 Select methods are stripped and any remote host name is stripped down to
3789 just the host name."
3790   (let* ((name "")
3791          (foreign "")
3792          (depth 0)
3793          (skip 1)
3794          (levels (or levels
3795                      gnus-group-uncollapsed-levels
3796                      (progn
3797                        (while (string-match "\\." group skip)
3798                          (setq skip (match-end 0)
3799                                depth (+ depth 1)))
3800                        depth))))
3801     ;; Separate foreign select method from group name and collapse.
3802     ;; If method contains a server, collapse to non-domain server name,
3803     ;; otherwise collapse to select method.
3804     (let* ((colon (string-match ":" group))
3805            (server (and colon (substring group 0 colon)))
3806            (plus (and server (string-match "+" server))))
3807       (when server
3808         (if plus
3809             (setq foreign (substring server (+ 1 plus)
3810                                      (string-match "\\." server))
3811                   group (substring group (+ 1 colon)))
3812           (setq foreign server
3813                 group (substring group (+ 1 colon))))
3814         (setq foreign (concat foreign ":")))
3815       ;; Collapse group name leaving LEVELS uncollapsed elements
3816       (let* ((slist (split-string group "/"))
3817              (slen (length slist))
3818              (dlist (split-string group "\\."))
3819              (dlen (length dlist))
3820              glist
3821              glen
3822              gsep
3823              res)
3824         (if (> slen dlen)
3825             (setq glist slist
3826                   glen slen
3827                   gsep "/")
3828           (setq glist dlist
3829                 glen dlen
3830                 gsep "."))
3831         (setq levels (- glen levels))
3832         (dolist (g glist)
3833           (push (if (>= (decf levels) 0)
3834                     (if (zerop (length g))
3835                         ""
3836                       (substring g 0 1))
3837                   g)
3838                 res))
3839         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3840
3841 (defun gnus-narrow-to-body ()
3842   "Narrow to the body of an article."
3843   (narrow-to-region
3844    (progn
3845      (goto-char (point-min))
3846      (or (search-forward "\n\n" nil t)
3847          (point-max)))
3848    (point-max)))
3849
3850 \f
3851 ;;;
3852 ;;; Kill file handling.
3853 ;;;
3854
3855 (defun gnus-apply-kill-file ()
3856   "Apply a kill file to the current newsgroup.
3857 Returns the number of articles marked as read."
3858   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3859           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3860       (gnus-apply-kill-file-internal)
3861     0))
3862
3863 (defun gnus-kill-save-kill-buffer ()
3864   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3865     (when (get-file-buffer file)
3866       (save-excursion
3867         (set-buffer (get-file-buffer file))
3868         (when (buffer-modified-p)
3869           (save-buffer))
3870         (kill-buffer (current-buffer))))))
3871
3872 (defcustom gnus-kill-file-name "KILL"
3873   "Suffix of the kill files."
3874   :group 'gnus-score-kill
3875   :group 'gnus-score-files
3876   :type 'string)
3877
3878 (defun gnus-newsgroup-kill-file (newsgroup)
3879   "Return the name of a kill file name for NEWSGROUP.
3880 If NEWSGROUP is nil, return the global kill file name instead."
3881   (cond
3882    ;; The global KILL file is placed at top of the directory.
3883    ((or (null newsgroup)
3884         (string-equal newsgroup ""))
3885     (expand-file-name gnus-kill-file-name
3886                       gnus-kill-files-directory))
3887    ;; Append ".KILL" to newsgroup name.
3888    ((gnus-use-long-file-name 'not-kill)
3889     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3890                               "." gnus-kill-file-name)
3891                       gnus-kill-files-directory))
3892    ;; Place "KILL" under the hierarchical directory.
3893    (t
3894     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3895                               "/" gnus-kill-file-name)
3896                       gnus-kill-files-directory))))
3897
3898 ;;; Server things.
3899
3900 (defun gnus-member-of-valid (symbol group)
3901   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3902   (memq symbol (assoc
3903                 (symbol-name (car (gnus-find-method-for-group group)))
3904                 gnus-valid-select-methods)))
3905
3906 (defun gnus-method-option-p (method option)
3907   "Return non-nil if select METHOD has OPTION as a parameter."
3908   (when (stringp method)
3909     (setq method (gnus-server-to-method method)))
3910   (memq option (assoc (format "%s" (car method))
3911                       gnus-valid-select-methods)))
3912
3913 (defun gnus-similar-server-opened (method)
3914   (let ((opened gnus-opened-servers))
3915     (while (and method opened)
3916       (when (and (equal (cadr method) (cadaar opened))
3917                  (equal (car method) (caaar opened))
3918                  (not (equal method (caar opened))))
3919         (setq method nil))
3920       (pop opened))
3921     (not method)))
3922
3923 (defun gnus-server-extend-method (group method)
3924   ;; This function "extends" a virtual server.  If the server is
3925   ;; "hello", and the select method is ("hello" (my-var "something"))
3926   ;; in the group "alt.alt", this will result in a new virtual server
3927   ;; called "hello+alt.alt".
3928   (if (or (not (inline (gnus-similar-server-opened method)))
3929           (not (cddr method)))
3930       method
3931     `(,(car method) ,(concat (cadr method) "+" group)
3932       (,(intern (format "%s-address" (car method))) ,(cadr method))
3933       ,@(cddr method))))
3934
3935 (defun gnus-server-status (method)
3936   "Return the status of METHOD."
3937   (nth 1 (assoc method gnus-opened-servers)))
3938
3939 (defun gnus-group-name-to-method (group)
3940   "Guess a select method based on GROUP."
3941   (if (string-match ":" group)
3942       (let ((server (substring group 0 (match-beginning 0))))
3943         (if (string-match "\\+" server)
3944             (list (intern (substring server 0 (match-beginning 0)))
3945                   (substring server (match-end 0)))
3946           (list (intern server) "")))
3947     gnus-select-method))
3948
3949 (defun gnus-server-string (server)
3950   "Return a readable string that describes SERVER."
3951   (let* ((server (gnus-server-to-method server))
3952          (address (nth 1 server)))
3953     (if (and address
3954              (not (zerop (length address))))
3955         (format "%s using %s" address (car server))
3956       (format "%s" (car server)))))
3957
3958 (defun gnus-find-method-for-group (group &optional info)
3959   "Find the select method that GROUP uses."
3960   (or gnus-override-method
3961       (and (not group)
3962            gnus-select-method)
3963       (and (not (gnus-group-entry group));; a new group
3964            (gnus-group-name-to-method group))
3965       (let ((info (or info (gnus-get-info group)))
3966             method)
3967         (if (or (not info)
3968                 (not (setq method (gnus-info-method info)))
3969                 (equal method "native"))
3970             gnus-select-method
3971           (setq method
3972                 (cond ((stringp method)
3973                        (inline (gnus-server-to-method method)))
3974                       ((stringp (cadr method))
3975                        (inline (gnus-server-extend-method group method)))
3976                       (t
3977                        method)))
3978           (cond ((equal (cadr method) "")
3979                  method)
3980                 ((null (cadr method))
3981                  (list (car method) ""))
3982                 (t
3983                  (gnus-server-add-address method)))))))
3984
3985 (defun gnus-methods-using (feature)
3986   "Find all methods that have FEATURE."
3987   (let ((valids gnus-valid-select-methods)
3988         outs)
3989     (while valids
3990       (when (memq feature (car valids))
3991         (push (car valids) outs))
3992       (setq valids (cdr valids)))
3993     outs))
3994
3995 (eval-when-compile
3996   (autoload 'message-y-or-n-p "message" nil nil 'macro))
3997
3998 (defun gnus-read-group (prompt &optional default)
3999   "Prompt the user for a group name.
4000 Disallow invalid group names."
4001   (let ((prefix "")
4002         group)
4003     (while (not group)
4004       (when (string-match
4005              gnus-invalid-group-regexp
4006              (setq group (read-string (concat prefix prompt)
4007                                       (cons (or default "") 0)
4008                                       'gnus-group-history)))
4009         (let ((match (match-string 0 group)))
4010           ;; Might be okay (e.g. for nnimap), so ask the user:
4011           (unless (and (not (string-match "^$\\|:" match))
4012                        (message-y-or-n-p
4013                         "Proceed and create group anyway? " t
4014 "The group name \"" group "\" contains a forbidden character: \"" match "\".
4015
4016 Usually, it's dangerous to create a group with this name, because it's not
4017 supported by all back ends and servers.  On IMAP servers it should work,
4018 though.  If you are really sure, you can proceed anyway and create the group.
4019
4020 You may customize the variable `gnus-invalid-group-regexp', which currently is
4021 set to \"" gnus-invalid-group-regexp
4022 "\", if you want to get rid of this query permanently."))
4023             (setq prefix (format "Invalid group name: \"%s\".  " group)
4024                   group nil)))))
4025     group))
4026
4027 (defun gnus-read-method (prompt)
4028   "Prompt the user for a method.
4029 Allow completion over sensible values."
4030   (let* ((open-servers
4031           (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
4032                   gnus-opened-servers))
4033          (valid-methods
4034           (let (methods)
4035             (dolist (method gnus-valid-select-methods)
4036               (if (or (memq 'prompt-address method)
4037                       (not (assoc (format "%s:" (car method)) open-servers)))
4038                   (push method methods)))
4039             methods))
4040          (servers
4041           (append valid-methods
4042                   open-servers
4043                   gnus-predefined-server-alist
4044                   gnus-server-alist))
4045          (method
4046           (completing-read
4047            prompt servers
4048            nil t nil 'gnus-method-history)))
4049     (cond
4050      ((equal method "")
4051       (setq method gnus-select-method))
4052      ((assoc method gnus-valid-select-methods)
4053       (let ((address (if (memq 'prompt-address
4054                                (assoc method gnus-valid-select-methods))
4055                          (read-string "Address: ")
4056                        "")))
4057         (or (cadr (assoc (format "%s:%s" method address) open-servers))
4058             (list (intern method) address))))
4059      ((assoc method servers)
4060       method)
4061      (t
4062       (list (intern method) "")))))
4063
4064 ;;; Agent functions
4065
4066 (defun gnus-agent-method-p (method)
4067   "Say whether METHOD is covered by the agent."
4068   (or (eq (car gnus-agent-method-p-cache) method)
4069       (setq gnus-agent-method-p-cache 
4070             (cons method
4071                   (member (if (stringp method) 
4072                               method 
4073                             (gnus-method-to-server method)) gnus-agent-covered-methods))))
4074   (cdr gnus-agent-method-p-cache))
4075
4076 (defun gnus-online (method)
4077   (not
4078    (if gnus-plugged
4079        (eq (cadr (assoc method gnus-opened-servers)) 'offline)
4080      (gnus-agent-method-p method))))
4081
4082 ;;; User-level commands.
4083
4084 ;;;###autoload
4085 (defun gnus-slave-no-server (&optional arg)
4086   "Read network news as a slave, without connecting to the local server."
4087   (interactive "P")
4088   (gnus-no-server arg t))
4089
4090 ;;;###autoload
4091 (defun gnus-no-server (&optional arg slave)
4092   "Read network news.
4093 If ARG is a positive number, Gnus will use that as the startup
4094 level. If ARG is nil, Gnus will be started at level 2.  If ARG is
4095 non-nil and not a positive number, Gnus will prompt the user for the
4096 name of an NNTP server to use.
4097 As opposed to `gnus', this command will not connect to the local
4098 server."
4099   (interactive "P")
4100   (gnus-no-server-1 arg slave))
4101
4102 ;;;###autoload
4103 (defun gnus-slave (&optional arg)
4104   "Read news as a slave."
4105   (interactive "P")
4106   (gnus arg nil 'slave))
4107
4108 (defcustom gnus-frame-properties nil
4109   "The properties of the frame in which gnus is displayed. Under XEmacs,
4110 the variable `toolbar-news-frame-plist' will be refered instead."
4111   :type '(repeat (cons :format "%v"
4112                        (symbol :tag "Parameter")
4113                        (sexp :tag "Value")))
4114   :group 'gnus)
4115
4116 ;;;###autoload
4117 (defun gnus-other-frame (&optional arg display)
4118   "Pop up a frame to read news.
4119 This will call one of the Gnus commands which is specified by the user
4120 option `gnus-other-frame-function' (default `gnus') with the argument
4121 ARG if Gnus is not running, otherwise just pop up a Gnus frame.  The
4122 optional second argument DISPLAY should be a standard display string
4123 such as \"unix:0\" to specify where to pop up a frame.  If DISPLAY is
4124 omitted or the function `make-frame-on-display' is not available, the
4125 current display is used."
4126   (interactive "P")
4127   (if (fboundp 'make-frame-on-display)
4128       (unless display
4129         (setq display (gnus-frame-or-window-display-name (selected-frame))))
4130     (setq display nil))
4131   (let ((alive (gnus-alive-p)))
4132     (unless (and alive
4133                  (catch 'found
4134                    (walk-windows
4135                     (lambda (window)
4136                       (when (and (or (not display)
4137                                      (equal display
4138                                             (gnus-frame-or-window-display-name
4139                                              window)))
4140                                  (with-current-buffer (window-buffer window)
4141                                    (string-match "\\`gnus-"
4142                                                  (symbol-name major-mode))))
4143                         (gnus-select-frame-set-input-focus
4144                          (setq gnus-other-frame-object (window-frame window)))
4145                         (select-window window)
4146                         (throw 'found t)))
4147                     'ignore t)))
4148       (gnus-select-frame-set-input-focus
4149        (setq gnus-other-frame-object
4150              (if display
4151                  (make-frame-on-display display gnus-other-frame-parameters)
4152                (make-frame gnus-other-frame-parameters))))
4153       (if alive
4154           (switch-to-buffer gnus-group-buffer)
4155         (funcall gnus-other-frame-function arg)
4156         (add-hook 'gnus-exit-gnus-hook
4157                   '(lambda nil
4158                      (when (and (frame-live-p gnus-other-frame-object)
4159                                 (cdr (frame-list)))
4160                        (delete-frame gnus-other-frame-object))
4161                      (setq gnus-other-frame-object nil)))))))
4162
4163 ;;;###autoload
4164 (defun gnus (&optional arg dont-connect slave)
4165   "Read network news.
4166 If ARG is non-nil and a positive number, Gnus will use that as the
4167 startup level.  If ARG is non-nil and not a positive number, Gnus will
4168 prompt the user for the name of an NNTP server to use."
4169   (interactive "P")
4170   (unless (byte-code-function-p (symbol-function 'gnus))
4171     (message "You should byte-compile Gnus")
4172     (sit-for 2))
4173   (gnus-1 arg dont-connect slave))
4174
4175 ;; Allow redefinition of Gnus functions.
4176
4177 (gnus-ems-redefine)
4178
4179 (product-provide (provide 'gnus) 'gnus-vers)
4180
4181 ;;; gnus.el ends here