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