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