(gnus-thread-sort-functions)
[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              (let ((name (buffer-string)))
1104                (unless (string-match "\\`[ \t\n]*$" name)
1105                  name))))))
1106
1107 (defcustom gnus-select-method
1108   (condition-case nil
1109       (nconc
1110        (list 'nntp (or (condition-case nil
1111                            (gnus-getenv-nntpserver)
1112                          (error nil))
1113                        (when (and gnus-default-nntp-server
1114                                   (not (string= gnus-default-nntp-server "")))
1115                          gnus-default-nntp-server)
1116                        "news"))
1117        (if (or (null gnus-nntp-service)
1118                (equal gnus-nntp-service "nntp"))
1119            nil
1120          (list gnus-nntp-service)))
1121     (error nil))
1122   "Default method for selecting a newsgroup.
1123 This variable should be a list, where the first element is how the
1124 news is to be fetched, the second is the address.
1125
1126 For instance, if you want to get your news via \"flab.flab.edu\" using
1127 NNTP, you could say:
1128
1129 \(setq gnus-select-method '(nntp \"flab.flab.edu\"))
1130
1131 If you want to use your local spool, say:
1132
1133 \(setq gnus-select-method (list 'nnspool (system-name)))
1134
1135 If you use this variable, you must set `gnus-nntp-server' to nil.
1136
1137 There is a lot more to know about select methods and virtual servers -
1138 see the manual for details."
1139   :group 'gnus-server
1140   :type 'gnus-select-method)
1141
1142 (defcustom gnus-message-archive-method "archive"
1143   "*Method used for archiving messages you've sent.
1144 This should be a mail method."
1145   :group 'gnus-server
1146   :group 'gnus-message
1147   :type '(choice (const :tag "Default archive method" "archive")
1148                  gnus-select-method))
1149
1150 (defcustom gnus-message-archive-group nil
1151   "*Name of the group in which to save the messages you've written.
1152 This can either be a string; a list of strings; or an alist
1153 of regexps/functions/forms to be evaluated to return a string (or a list
1154 of strings).  The functions are called with the name of the current
1155 group (or nil) as a parameter.
1156
1157 If you want to save your mail in one group and the news articles you
1158 write in another group, you could say something like:
1159
1160  \(setq gnus-message-archive-group
1161         '((if (message-news-p)
1162               \"misc-news\"
1163             \"misc-mail\")))
1164
1165 Normally the group names returned by this variable should be
1166 unprefixed -- which implicitly means \"store on the archive server\".
1167 However, you may wish to store the message on some other server.  In
1168 that case, just return a fully prefixed name of the group --
1169 \"nnml+private:mail.misc\", for instance."
1170   :group 'gnus-message
1171   :type '(choice (const :tag "none" nil)
1172                  function
1173                  sexp
1174                  string))
1175
1176 (defcustom gnus-secondary-servers nil
1177   "List of NNTP servers that the user can choose between interactively.
1178 To make Gnus query you for a server, you have to give `gnus' a
1179 non-numeric prefix - `C-u M-x gnus', in short."
1180   :group 'gnus-server
1181   :type '(repeat string))
1182
1183 (defcustom gnus-nntp-server nil
1184   "*The name of the host running the NNTP server.
1185 This variable is semi-obsolete.  Use the `gnus-select-method'
1186 variable instead."
1187   :group 'gnus-server
1188   :type '(choice (const :tag "disable" nil)
1189                  string))
1190
1191 (defcustom gnus-secondary-select-methods nil
1192   "A list of secondary methods that will be used for reading news.
1193 This is a list where each element is a complete select method (see
1194 `gnus-select-method').
1195
1196 If, for instance, you want to read your mail with the nnml back end,
1197 you could set this variable:
1198
1199 \(setq gnus-secondary-select-methods '((nnml \"\")))"
1200   :group 'gnus-server
1201   :type '(repeat gnus-select-method))
1202
1203 (defvar gnus-backup-default-subscribed-newsgroups
1204   '("news.announce.newusers" "news.groups.questions" "gnu.emacs.gnus")
1205   "Default default new newsgroups the first time Gnus is run.
1206 Should be set in paths.el, and shouldn't be touched by the user.")
1207
1208 (defcustom gnus-local-domain nil
1209   "Local domain name without a host name.
1210 The DOMAINNAME environment variable is used instead if it is defined.
1211 If the function `system-name' returns the full Internet name, there is
1212 no need to set this variable."
1213   :group 'gnus-message
1214   :type '(choice (const :tag "default" nil)
1215                  string))
1216
1217 (defvar gnus-local-organization nil
1218   "String with a description of what organization (if any) the user belongs to.
1219 Obsolete variable; use `message-user-organization' instead.")
1220
1221 ;; Customization variables
1222
1223 (defcustom gnus-refer-article-method nil
1224   "Preferred method for fetching an article by Message-ID.
1225 If you are reading news from the local spool (with nnspool), fetching
1226 articles by Message-ID is painfully slow.  By setting this method to an
1227 nntp method, you might get acceptable results.
1228
1229 The value of this variable must be a valid select method as discussed
1230 in the documentation of `gnus-select-method'.
1231
1232 It can also be a list of select methods, as well as the special symbol
1233 `current', which means to use the current select method.  If it is a
1234 list, Gnus will try all the methods in the list until it finds a match."
1235   :group 'gnus-server
1236   :type '(choice (const :tag "default" nil)
1237                  (const current)
1238                  (const :tag "Google" (nnweb "refer" (nnweb-type google)))
1239                  gnus-select-method
1240                  (repeat :menu-tag "Try multiple"
1241                          :tag "Multiple"
1242                          :value (current (nnweb "refer" (nnweb-type google)))
1243                          (choice :tag "Method"
1244                                  (const current)
1245                                  (const :tag "Google"
1246                                         (nnweb "refer" (nnweb-type google)))
1247                                  gnus-select-method))))
1248
1249 (defcustom gnus-group-faq-directory
1250   '("/ftp@mirrors.aol.com:/pub/rtfm/usenet/"
1251     "/ftp@sunsite.doc.ic.ac.uk:/pub/usenet/news-faqs/"
1252     "/ftp@src.doc.ic.ac.uk:/usenet/news-FAQS/"
1253     "/ftp@ftp.seas.gwu.edu:/pub/rtfm/"
1254     "/ftp@ftp.pasteur.fr:/pub/FAQ/"
1255     "/ftp@rtfm.mit.edu:/pub/usenet/"
1256     "/ftp@ftp.uni-paderborn.de:/pub/FAQ/"
1257     "/ftp@ftp.sunet.se:/pub/usenet/"
1258     "/ftp@nctuccca.nctu.edu.tw:/pub/Documents/rtfm/usenet-by-group/"
1259     "/ftp@hwarang.postech.ac.kr:/pub/usenet/"
1260     "/ftp@ftp.hk.super.net:/mirror/faqs/")
1261   "*Directory where the group FAQs are stored.
1262 This will most commonly be on a remote machine, and the file will be
1263 fetched by ange-ftp.
1264
1265 This variable can also be a list of directories.  In that case, the
1266 first element in the list will be used by default.  The others can
1267 be used when being prompted for a site.
1268
1269 Note that Gnus uses an aol machine as the default directory.  If this
1270 feels fundamentally unclean, just think of it as a way to finally get
1271 something of value back from them.
1272
1273 If the default site is too slow, try one of these:
1274
1275    North America: mirrors.aol.com                /pub/rtfm/usenet
1276                   ftp.seas.gwu.edu               /pub/rtfm
1277                   rtfm.mit.edu                   /pub/usenet
1278    Europe:        ftp.uni-paderborn.de           /pub/FAQ
1279                   src.doc.ic.ac.uk               /usenet/news-FAQS
1280                   ftp.sunet.se                   /pub/usenet
1281                   ftp.pasteur.fr                 /pub/FAQ
1282    Asia:          nctuccca.nctu.edu.tw           /pub/Documents/rtfm/usenet-by-group/
1283                   hwarang.postech.ac.kr          /pub/usenet
1284                   ftp.hk.super.net               /mirror/faqs"
1285   :group 'gnus-group-various
1286   :type '(choice directory
1287                  (repeat directory)))
1288
1289 (defcustom gnus-group-charter-alist
1290   '(("no" . (concat "http://no.news-admin.org/charter/" name ".txt"))
1291     ("de" . (concat "http://purl.net/charta/" name ".html"))
1292     ("dk" . (concat "http://www.usenet.dk/grupper.pl?get=" name))
1293     ("england" . (concat "http://england.news-admin.org/charters/" name))
1294     ("fr" . (concat "http://www.usenet-fr.net/fur/chartes/" name ".html"))
1295     ("europa" . (concat "http://www.europa.usenet.eu.org/chartas/charta-en-"
1296                         (gnus-replace-in-string name "europa\\." "") ".html"))
1297     ("nl" . (concat "http://www.xs4all.nl/~sister/usenet/charters/" name))
1298     ("aus" . (concat "http://aus.news-admin.org/groupinfo.cgi/" name))
1299     ("pl" . (concat "http://www.usenet.pl/opisy/" name))
1300     ("ch" . (concat "http://www.use-net.ch/Usenet/charter.html#" name))
1301     ("at" . (concat "http://www.usenet.at/chartas/" name "/charta"))
1302     ("uk" . (concat "http://www.usenet.org.uk/" name ".html"))
1303     ("dfw" . (concat "http://www.cirr.com/dfw/charters/" name ".html"))
1304     ("se" . (concat "http://www.usenet-se.net/Reglementen/"
1305                     (gnus-replace-in-string name "\\." "_") ".html"))
1306     ("milw" . (concat "http://usenet.mil.wi.us/"
1307                       (gnus-replace-in-string name "milw\\." "") "-charter"))
1308     ("ca" . (concat "http://www.sbay.org/ca/charter-" name ".html"))
1309     ("netins" . (concat "http://www.netins.net/usenet/charter/"
1310                         (gnus-replace-in-string name "\\." "-") "-charter.html")))
1311   "*An alist of (HIERARCHY . FORM) pairs used to construct the URL of a charter.
1312 When FORM is evaluated `name' is bound to the name of the group."
1313   :group 'gnus-group-various
1314   :type '(repeat (cons (string :tag "Hierarchy") (sexp :tag "Form"))))
1315
1316 (defcustom gnus-group-fetch-control-use-browse-url nil
1317   "*Non-nil means that control messages are displayed using `browse-url'.
1318 Otherwise they are fetched with ange-ftp and displayed in an ephemeral
1319 group."
1320   :group 'gnus-group-various
1321   :type 'boolean)
1322
1323 (defcustom gnus-use-cross-reference t
1324   "*Non-nil means that cross referenced articles will be marked as read.
1325 If nil, ignore cross references.  If t, mark articles as read in
1326 subscribed newsgroups.  If neither t nor nil, mark as read in all
1327 newsgroups."
1328   :group 'gnus-server
1329   :type '(choice (const :tag "off" nil)
1330                  (const :tag "subscribed" t)
1331                  (sexp :format "all"
1332                        :value always)))
1333
1334 (defcustom gnus-process-mark ?#
1335   "*Process mark."
1336   :group 'gnus-group-visual
1337   :group 'gnus-summary-marks
1338   :type 'character)
1339
1340 (defcustom gnus-large-newsgroup 200
1341   "*The number of articles which indicates a large newsgroup.
1342 If the number of articles in a newsgroup is greater than this value,
1343 confirmation is required for selecting the newsgroup.
1344 If it is nil, no confirmation is required."
1345   :group 'gnus-group-select
1346   :type '(choice (const :tag "No limit" nil)
1347                  integer))
1348
1349 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1350   "*Non-nil means that the default name of a file to save articles in is the group name.
1351 If it's nil, the directory form of the group name is used instead.
1352
1353 If this variable is a list, and the list contains the element
1354 `not-score', long file names will not be used for score files; if it
1355 contains the element `not-save', long file names will not be used for
1356 saving; and if it contains the element `not-kill', long file names
1357 will not be used for kill files.
1358
1359 Note that the default for this variable varies according to what system
1360 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1361 to nil while on all other systems it defaults to t."
1362   :group 'gnus-start
1363   :type '(radio (sexp :format "Non-nil\n"
1364                       :match (lambda (widget value)
1365                                (and value (not (listp value))))
1366                       :value t)
1367                 (const nil)
1368                 (checklist (const :format "%v " not-score)
1369                            (const :format "%v " not-save)
1370                            (const not-kill))))
1371
1372 (defcustom gnus-kill-files-directory gnus-directory
1373   "*Name of the directory where kill files will be stored (default \"~/News\")."
1374   :group 'gnus-score-files
1375   :group 'gnus-score-kill
1376   :type 'directory)
1377
1378 (defcustom gnus-save-score nil
1379   "*If non-nil, save group scoring info."
1380   :group 'gnus-score-various
1381   :group 'gnus-start
1382   :type 'boolean)
1383
1384 (defcustom gnus-use-undo t
1385   "*If non-nil, allow undoing in Gnus group mode buffers."
1386   :group 'gnus-meta
1387   :type 'boolean)
1388
1389 (defcustom gnus-use-adaptive-scoring nil
1390   "*If non-nil, use some adaptive scoring scheme.
1391 If a list, then the values `word' and `line' are meaningful.  The
1392 former will perform adaption on individual words in the subject
1393 header while `line' will perform adaption on several headers."
1394   :group 'gnus-meta
1395   :group 'gnus-score-adapt
1396   :type '(set (const word) (const line)))
1397
1398 (defcustom gnus-use-cache 'passive
1399   "*If nil, Gnus will ignore the article cache.
1400 If `passive', it will allow entering (and reading) articles
1401 explicitly entered into the cache.  If anything else, use the
1402 cache to the full extent of the law."
1403   :group 'gnus-meta
1404   :group 'gnus-cache
1405   :type '(choice (const :tag "off" nil)
1406                  (const :tag "passive" passive)
1407                  (const :tag "active" t)))
1408
1409 (defcustom gnus-use-trees nil
1410   "*If non-nil, display a thread tree buffer."
1411   :group 'gnus-meta
1412   :type 'boolean)
1413
1414 (defcustom gnus-keep-backlog 20
1415   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1416 If it is a number N, then Gnus will only keep the last N articles
1417 read.  If it is neither nil nor a number, Gnus will keep all read
1418 articles.  This is not a good idea."
1419   :group 'gnus-meta
1420   :type '(choice (const :tag "off" nil)
1421                  integer
1422                  (sexp :format "all"
1423                        :value t)))
1424
1425 (defcustom gnus-use-nocem nil
1426   "*If non-nil, Gnus will read NoCeM cancel messages."
1427   :group 'gnus-meta
1428   :type 'boolean)
1429
1430 (defcustom gnus-suppress-duplicates nil
1431   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1432   :group 'gnus-meta
1433   :type 'boolean)
1434
1435 (defcustom gnus-use-scoring t
1436   "*If non-nil, enable scoring."
1437   :group 'gnus-meta
1438   :type 'boolean)
1439
1440 (defcustom gnus-summary-prepare-exit-hook
1441   '(gnus-summary-expire-articles)
1442   "*A hook called when preparing to exit from the summary buffer.
1443 It calls `gnus-summary-expire-articles' by default."
1444   :group 'gnus-summary-exit
1445   :type 'hook)
1446
1447 (defcustom gnus-novice-user t
1448   "*Non-nil means that you are a Usenet novice.
1449 If non-nil, verbose messages may be displayed and confirmations may be
1450 required."
1451   :group 'gnus-meta
1452   :type 'boolean)
1453
1454 (defcustom gnus-expert-user nil
1455   "*Non-nil means that you will never be asked for confirmation about anything.
1456 That doesn't mean *anything* anything; particularly destructive
1457 commands will still require prompting."
1458   :group 'gnus-meta
1459   :type 'boolean)
1460
1461 (defcustom gnus-interactive-catchup t
1462   "*If non-nil, require your confirmation when catching up a group."
1463   :group 'gnus-group-select
1464   :type 'boolean)
1465
1466 (defcustom gnus-interactive-exit t
1467   "*If non-nil, require your confirmation when exiting Gnus."
1468   :group 'gnus-exit
1469   :type 'boolean)
1470
1471 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1472   "*Function for extracting address components from a From header.
1473 Two pre-defined function exist: `gnus-extract-address-components',
1474 which is the default, quite fast, and too simplistic solution, and
1475 `mail-extract-address-components', which works much better, but is
1476 slower."
1477   :group 'gnus-summary-format
1478   :type '(radio (function-item gnus-extract-address-components)
1479                 (function-item mail-extract-address-components)
1480                 (function :tag "Other")))
1481
1482 (defcustom gnus-carpal nil
1483   "*If non-nil, display clickable icons."
1484   :group 'gnus-meta
1485   :type 'boolean)
1486
1487 (defcustom gnus-shell-command-separator ";"
1488   "String used to separate shell commands."
1489   :group 'gnus-files
1490   :type 'string)
1491
1492 (defcustom gnus-valid-select-methods
1493   '(("nntp" post address prompt-address physical-address)
1494     ("nnspool" post address)
1495     ("nnvirtual" post-mail virtual prompt-address)
1496     ("nnmbox" mail respool address)
1497     ("nnml" post-mail respool address)
1498     ("nnmh" mail respool address)
1499     ("nndir" post-mail prompt-address physical-address)
1500     ("nneething" none address prompt-address physical-address)
1501     ("nndoc" none address prompt-address)
1502     ("nnbabyl" mail address respool)
1503     ("nnkiboze" post virtual)
1504     ("nnsoup" post-mail address)
1505     ("nndraft" post-mail)
1506     ("nnfolder" mail respool address)
1507     ("nngateway" post-mail address prompt-address physical-address)
1508     ("nnweb" none)
1509     ("nngoogle" post)
1510     ("nnslashdot" post)
1511     ("nnultimate" none)
1512     ("nnrss" none)
1513     ("nnwfm" none)
1514     ("nnwarchive" none)
1515     ("nnlistserv" none)
1516     ("nnagent" post-mail)
1517     ("nnimap" post-mail address prompt-address physical-address)
1518     ("nnmaildir" mail respool address)
1519     ("nnnil" none))
1520   "*An alist of valid select methods.
1521 The first element of each list lists should be a string with the name
1522 of the select method.  The other elements may be the category of
1523 this method (i. e., `post', `mail', `none' or whatever) or other
1524 properties that this method has (like being respoolable).
1525 If you implement a new select method, all you should have to change is
1526 this variable.  I think."
1527   :group 'gnus-server
1528   :type '(repeat (group (string :tag "Name")
1529                         (radio-button-choice (const :format "%v " post)
1530                                              (const :format "%v " mail)
1531                                              (const :format "%v " none)
1532                                              (const post-mail))
1533                         (checklist :inline t
1534                                    (const :format "%v " address)
1535                                    (const :format "%v " prompt-address)
1536                                    (const :format "%v " physical-address)
1537                                    (const :format "%v " virtual)
1538                                    (const respool)))))
1539
1540 (defun gnus-redefine-select-method-widget ()
1541   "Recomputes the select-method widget based on the value of
1542 `gnus-valid-select-methods'."
1543   (define-widget 'gnus-select-method 'list
1544     "Widget for entering a select method."
1545     :value '(nntp "")
1546     :tag "Select Method"
1547     :args `((choice :tag "Method"
1548                     ,@(mapcar (lambda (entry)
1549                                 (list 'const :format "%v\n"
1550                                       (intern (car entry))))
1551                               gnus-valid-select-methods)
1552                     (symbol :tag "other"))
1553             (string :tag "Address")
1554             (repeat :tag "Options"
1555                     :inline t
1556                     (list :format "%v"
1557                           variable
1558                           (sexp :tag "Value"))))))
1559
1560 (gnus-redefine-select-method-widget)
1561
1562 (defcustom gnus-updated-mode-lines '(group article summary tree)
1563   "List of buffers that should update their mode lines.
1564 The list may contain the symbols `group', `article', `tree' and
1565 `summary'.  If the corresponding symbol is present, Gnus will keep
1566 that mode line updated with information that may be pertinent.
1567 If this variable is nil, screen refresh may be quicker."
1568   :group 'gnus-various
1569   :type '(set (const group)
1570               (const article)
1571               (const summary)
1572               (const tree)))
1573
1574 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1575 (defcustom gnus-mode-non-string-length nil
1576   "*Max length of mode-line non-string contents.
1577 If this is nil, Gnus will take space as is needed, leaving the rest
1578 of the mode line intact.  Note that the default of nil is unlikely
1579 to be desirable; see the manual for further details."
1580   :group 'gnus-various
1581   :type '(choice (const nil)
1582                  integer))
1583
1584 ;; There should be special validation for this.
1585 (define-widget 'gnus-email-address 'string
1586   "An email address.")
1587
1588 (gnus-define-group-parameter
1589  to-address
1590  :function-document
1591  "Return GROUP's to-address."
1592  :variable-document
1593  "*Alist of group regexps and correspondent to-addresses."
1594  :parameter-type '(gnus-email-address :tag "To Address")
1595  :parameter-document "\
1596 This will be used when doing followups and posts.
1597
1598 This is primarily useful in mail groups that represent closed
1599 mailing lists--mailing lists where it's expected that everybody that
1600 writes to the mailing list is subscribed to it.  Since using this
1601 parameter ensures that the mail only goes to the mailing list itself,
1602 it means that members won't receive two copies of your followups.
1603
1604 Using `to-address' will actually work whether the group is foreign or
1605 not.  Let's say there's a group on the server that is called
1606 `fa.4ad-l'.  This is a real newsgroup, but the server has gotten the
1607 articles from a mail-to-news gateway.  Posting directly to this group
1608 is therefore impossible--you have to send mail to the mailing list
1609 address instead.
1610
1611 The gnus-group-split mail splitting mechanism will behave as if this
1612 address was listed in gnus-group-split Addresses (see below).")
1613
1614 (gnus-define-group-parameter
1615  to-list
1616  :function-document
1617  "Return GROUP's to-list."
1618  :variable-document
1619  "*Alist of group regexps and correspondent to-lists."
1620  :parameter-type '(gnus-email-address :tag "To List")
1621  :parameter-document "\
1622 This address will be used when doing a `a' in the group.
1623
1624 It is totally ignored when doing a followup--except that if it is
1625 present in a news group, you'll get mail group semantics when doing
1626 `f'.
1627
1628 The gnus-group-split mail splitting mechanism will behave as if this
1629 address was listed in gnus-group-split Addresses (see below).")
1630
1631 (gnus-define-group-parameter
1632  subscribed
1633  :type bool
1634  :function-document
1635  "Return GROUP's subscription status."
1636  :variable-document
1637  "*Groups which are automatically considered subscribed."
1638  :parameter-type '(const :tag "Subscribed" t)
1639  :parameter-document "\
1640 Gnus assumed that you are subscribed to the To/List address.
1641
1642 When constructing a list of subscribed groups using
1643 `gnus-find-subscribed-addresses', Gnus includes the To address given
1644 above, or the list address (if the To address has not been set).")
1645
1646 (gnus-define-group-parameter
1647  auto-expire
1648  :type bool
1649  :function gnus-group-auto-expirable-p
1650  :function-document
1651  "Check whether GROUP is auto-expirable or not."
1652  :variable gnus-auto-expirable-newsgroups
1653  :variable-default nil
1654  :variable-document
1655  "*Groups in which to automatically mark read articles as expirable.
1656 If non-nil, this should be a regexp that should match all groups in
1657 which to perform auto-expiry.  This only makes sense for mail groups."
1658  :variable-group nnmail-expire
1659  :variable-type '(choice (const nil)
1660                          regexp)
1661  :parameter-type '(const :tag "Automatic Expire" t)
1662  :parameter-document
1663  "All articles that are read will be marked as expirable.")
1664
1665 (gnus-define-group-parameter
1666  total-expire
1667  :type bool
1668  :function gnus-group-total-expirable-p
1669  :function-document
1670  "Check whether GROUP is total-expirable or not."
1671  :variable gnus-total-expirable-newsgroups
1672  :variable-default nil
1673  :variable-document
1674  "*Groups in which to perform expiry of all read articles.
1675 Use with extreme caution.  All groups that match this regexp will be
1676 expiring - which means that all read articles will be deleted after
1677 \(say) one week.         (This only goes for mail groups and the like, of
1678 course.)"
1679  :variable-group nnmail-expire
1680  :variable-type '(choice (const nil)
1681                          regexp)
1682  :parameter-type '(const :tag "Total Expire" t)
1683  :parameter-document
1684  "All read articles will be put through the expiry process
1685
1686 This happens even if they are not marked as expirable.
1687 Use with caution.")
1688
1689 (gnus-define-group-parameter
1690  charset
1691  :function-document
1692  "Return the default charset of GROUP."
1693  :variable gnus-group-charset-alist
1694  :variable-default
1695  '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1696    ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1697    ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1698    ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1699    ("\\(^\\|:\\)relcom\\>" koi8-r)
1700    ("\\(^\\|:\\)fido7\\>" koi8-r)
1701    ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1702    ("\\(^\\|:\\)israel\\>" iso-8859-1)
1703    ("\\(^\\|:\\)han\\>" euc-kr)
1704    ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1705    ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1706    ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1707  :variable-document
1708  "Alist of regexps (to match group names) and default charsets to be used when reading."
1709  :variable-group gnus-charset
1710  :variable-type '(repeat (list (regexp :tag "Group")
1711                                (symbol :tag "Charset")))
1712  :parameter-type '(symbol :tag "Charset")
1713  :parameter-document "\
1714 The default charset to use in the group.")
1715
1716 (gnus-define-group-parameter
1717  post-method
1718  :type list
1719  :function-document
1720  "Return a posting method for GROUP."
1721  :variable gnus-post-method-alist
1722  :variable-document
1723  "Alist of regexps (to match group names) and method to be used when
1724 posting an article."
1725  :variable-group gnus-group-foreign
1726  :parameter-type
1727  '(choice :tag "Posting Method"
1728           (const :tag "Use native server" native)
1729           (const :tag "Use current server" current)
1730           (list :convert-widget
1731                 (lambda (widget)
1732                   (list 'sexp :tag "Methods"
1733                         :value gnus-select-method))))
1734  :parameter-document
1735  "Posting method for this group.")
1736
1737 (gnus-define-group-parameter
1738  large-newsgroup-initial
1739  :type integer
1740  :function-document
1741  "Return GROUP's initial input of the number of articles."
1742  :variable-document
1743  "*Alist of group regexps and its initial input of the number of articles."
1744  :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1745                           (const :tag "All" nil)
1746                           (integer))
1747  :parameter-document "\
1748
1749 This number will be prompted as the initial value of the number of
1750 articles to list when the group is a large newsgroup (see
1751 `gnus-large-newsgroup').  If it is nil, the default value is the
1752 total number of articles in the group.")
1753
1754 ;; The Gnus registry's ignored groups
1755 (gnus-define-group-parameter
1756  registry-ignore
1757  :type list
1758  :function-document
1759  "Whether this group should be ignored by the registry."
1760  :variable gnus-registry-ignored-groups
1761  :variable-default nil
1762  :variable-document
1763  "*Groups in which the registry should be turned off."
1764  :variable-group gnus-registry
1765  :variable-type '(repeat
1766                   (list
1767                    (regexp :tag "Group Name Regular Expression")
1768                    (boolean :tag "Ignored")))
1769  
1770  :parameter-type '(boolean :tag "Group Ignored by the Registry")
1771  :parameter-document
1772  "Whether the Gnus Registry should ignore this group.")
1773
1774 ;; group parameters for spam processing added by Ted Zlatanov <tzz@lifelogs.com>
1775 (defcustom gnus-install-group-spam-parameters t
1776   "*Disable the group parameters for spam detection.
1777 Enable if `G c' in XEmacs is giving you trouble, and make sure to submit a bug report."
1778   :type 'boolean
1779   :group 'gnus-start)
1780
1781 (when gnus-install-group-spam-parameters
1782   (defvar gnus-group-spam-classification-spam t
1783     "Spam group classification (requires spam.el).
1784 This group contains spam messages.  On summary entry, unread messages
1785 will be marked as spam.  On summary exit, the specified spam
1786 processors will be invoked on spam-marked messages, then those
1787 messages will be expired, so the spam processor will only see a
1788 spam-marked message once.")
1789
1790   (defvar gnus-group-spam-classification-ham 'ask
1791     "The ham value for the spam group parameter (requires spam.el).
1792 On summary exit, the specified ham processors will be invoked on
1793 ham-marked messages.  Exercise caution, since the ham processor will
1794 see the same message more than once because there is no ham message
1795 registry.")
1796
1797   (gnus-define-group-parameter
1798    spam-contents
1799    :type list
1800    :function-document
1801    "The spam type (spam, ham, or neither) of the group."
1802    :variable gnus-spam-newsgroup-contents
1803    :variable-default nil
1804    :variable-document
1805    "*Groups in which to automatically mark new articles as spam on
1806 summary entry.  If non-nil, this should be a list of group name
1807 regexps that should match all groups in which to do automatic spam
1808 tagging, associated with a classification (spam, ham, or neither).
1809 This only makes sense for mail groups."
1810    :variable-group spam
1811    :variable-type '(repeat
1812                     (list :tag "Group contents spam/ham classification"
1813                           (regexp :tag "Group")
1814                           (choice
1815                            (variable-item gnus-group-spam-classification-spam)
1816                            (variable-item gnus-group-spam-classification-ham)
1817                            (const :tag "Unclassified" nil))))
1818
1819    :parameter-type '(list :tag "Group contents spam/ham classification"
1820                           (choice :tag "Group contents classification for spam sorting"
1821                                   (variable-item gnus-group-spam-classification-spam)
1822                                   (variable-item gnus-group-spam-classification-ham)
1823                                   (const :tag "Unclassified" nil)))
1824    :parameter-document
1825    "The spam classification (spam, ham, or neither) of this group.
1826 When a spam group is entered, all unread articles are marked as spam.")
1827
1828   (defvar gnus-group-spam-exit-processor-ifile "ifile"
1829     "OBSOLETE: The ifile summary exit spam processor.")
1830
1831   (defvar gnus-group-spam-exit-processor-stat "stat"
1832     "OBSOLETE: The spam-stat summary exit spam processor.")
1833
1834   (defvar gnus-group-spam-exit-processor-bogofilter "bogofilter"
1835     "OBSOLETE: The Bogofilter summary exit spam processor.")
1836
1837   (defvar gnus-group-spam-exit-processor-blacklist "blacklist"
1838     "OBSOLETE: The Blacklist summary exit spam processor.")
1839
1840   (defvar gnus-group-spam-exit-processor-report-gmane "report-gmane"
1841     "OBSOLETE: The Gmane reporting summary exit spam processor.
1842 Only applicable to NNTP groups with articles from Gmane.  See spam-report.el")
1843
1844   (defvar gnus-group-spam-exit-processor-spamoracle "spamoracle-spam"
1845     "OBSOLETE: The spamoracle summary exit spam processor.")
1846
1847   (defvar gnus-group-ham-exit-processor-ifile "ifile-ham"
1848     "OBSOLETE: The ifile summary exit ham processor.
1849 Only applicable to non-spam (unclassified and ham) groups.")
1850
1851   (defvar gnus-group-ham-exit-processor-bogofilter "bogofilter-ham"
1852     "OBSOLETE: The Bogofilter summary exit ham processor.
1853 Only applicable to non-spam (unclassified and ham) groups.")
1854
1855   (defvar gnus-group-ham-exit-processor-stat "stat-ham"
1856     "OBSOLETE: The spam-stat summary exit ham processor.
1857 Only applicable to non-spam (unclassified and ham) groups.")
1858
1859   (defvar gnus-group-ham-exit-processor-whitelist "whitelist"
1860     "OBSOLETE: The whitelist summary exit ham processor.
1861 Only applicable to non-spam (unclassified and ham) groups.")
1862
1863   (defvar gnus-group-ham-exit-processor-BBDB "bbdb"
1864     "OBSOLETE: The BBDB summary exit ham processor.
1865 Only applicable to non-spam (unclassified and ham) groups.")
1866
1867   (defvar gnus-group-ham-exit-processor-copy "copy"
1868     "OBSOLETE: The ham copy exit ham processor.
1869 Only applicable to non-spam (unclassified and ham) groups.")
1870
1871   (defvar gnus-group-ham-exit-processor-spamoracle "spamoracle-ham"
1872     "OBSOLETE: The spamoracle summary exit ham processor.
1873 Only applicable to non-spam (unclassified and ham) groups.")
1874
1875   (gnus-define-group-parameter
1876    spam-process
1877    :type list
1878    :parameter-type 
1879    '(choice 
1880      :tag "Spam Summary Exit Processor"
1881      :value nil
1882      (list :tag "Spam Summary Exit Processor Choices"
1883            (set
1884             (variable-item gnus-group-spam-exit-processor-ifile)
1885             (variable-item gnus-group-spam-exit-processor-stat)
1886             (variable-item gnus-group-spam-exit-processor-bogofilter)
1887             (variable-item gnus-group-spam-exit-processor-blacklist)
1888             (variable-item gnus-group-spam-exit-processor-spamoracle)
1889             (variable-item gnus-group-spam-exit-processor-report-gmane)
1890             (variable-item gnus-group-ham-exit-processor-bogofilter)
1891             (variable-item gnus-group-ham-exit-processor-ifile)
1892             (variable-item gnus-group-ham-exit-processor-stat)
1893             (variable-item gnus-group-ham-exit-processor-whitelist)
1894             (variable-item gnus-group-ham-exit-processor-BBDB)
1895             (variable-item gnus-group-ham-exit-processor-spamoracle)
1896             (variable-item gnus-group-ham-exit-processor-copy)
1897             (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
1898             (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
1899             (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
1900             (const :tag "Spam: ifile"         (spam spam-use-ifile))
1901             (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
1902             (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
1903             (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
1904             (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
1905             (const :tag "Ham: ifile"          (ham spam-use-ifile))
1906             (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
1907             (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
1908             (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
1909             (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
1910             (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
1911             (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle)))))
1912    :function-document
1913    "Which spam or ham processors will be applied when the summary is exited."
1914    :variable gnus-spam-process-newsgroups
1915    :variable-default nil
1916    :variable-document
1917    "*Groups in which to automatically process spam or ham articles with
1918 a backend on summary exit.  If non-nil, this should be a list of group
1919 name regexps that should match all groups in which to do automatic
1920 spam processing, associated with the appropriate processor."
1921    :variable-group spam
1922    :variable-type 
1923    '(repeat :tag "Spam/Ham Processors"
1924             (list :tag "Spam Summary Exit Processor Choices"
1925                   (regexp :tag "Group Regexp")
1926                   (set 
1927                    :tag "Spam/Ham Summary Exit Processor"
1928                    (variable-item gnus-group-spam-exit-processor-ifile)
1929                    (variable-item gnus-group-spam-exit-processor-stat)
1930                    (variable-item gnus-group-spam-exit-processor-bogofilter)
1931                    (variable-item gnus-group-spam-exit-processor-blacklist)
1932                    (variable-item gnus-group-spam-exit-processor-spamoracle)
1933                    (variable-item gnus-group-spam-exit-processor-report-gmane)
1934                    (variable-item gnus-group-ham-exit-processor-bogofilter)
1935                    (variable-item gnus-group-ham-exit-processor-ifile)
1936                    (variable-item gnus-group-ham-exit-processor-stat)
1937                    (variable-item gnus-group-ham-exit-processor-whitelist)
1938                    (variable-item gnus-group-ham-exit-processor-BBDB)
1939                    (variable-item gnus-group-ham-exit-processor-spamoracle)
1940                    (variable-item gnus-group-ham-exit-processor-copy)
1941                    (const :tag "Spam: Gmane Report"  (spam spam-use-gmane))
1942                    (const :tag "Spam: Bogofilter"    (spam spam-use-bogofilter))
1943                    (const :tag "Spam: Blacklist"     (spam spam-use-blacklist))
1944                    (const :tag "Spam: ifile"         (spam spam-use-ifile))
1945                    (const :tag "Spam: Spam-stat"     (spam spam-use-stat))
1946                    (const :tag "Spam: Spam Oracle"   (spam spam-use-spamoracle))
1947                    (const :tag "Spam: SpamAssassin"  (spam spam-use-spamassassin))
1948                    (const :tag "Ham: SpamAssassin"   (ham spam-use-spamassassin))
1949                    (const :tag "Ham: ifile"          (ham spam-use-ifile))
1950                    (const :tag "Ham: Bogofilter"     (ham spam-use-bogofilter))
1951                    (const :tag "Ham: Spam-stat"      (ham spam-use-stat))
1952                    (const :tag "Ham: Whitelist"      (ham spam-use-whitelist))
1953                    (const :tag "Ham: BBDB"           (ham spam-use-BBDB))
1954                    (const :tag "Ham: Copy"           (ham spam-use-ham-copy))
1955                    (const :tag "Ham: Spam Oracle"    (ham spam-use-spamoracle)))))
1956
1957    :parameter-document
1958    "Which spam or ham processors will be applied when the summary is exited.")
1959
1960   (gnus-define-group-parameter
1961    spam-autodetect
1962    :type list
1963    :parameter-type 
1964    '(boolean :tag "Spam autodetection")
1965    :function-document
1966    "Should spam be autodetected (with spam-split) in this group?"
1967    :variable gnus-spam-autodetect
1968    :variable-default nil
1969    :variable-document
1970    "*Groups in which spam should be autodetected when they are entered.
1971    Only unseen articles will be examined, unless
1972    spam-autodetect-recheck-messages is set."
1973    :variable-group spam
1974    :variable-type 
1975    '(repeat
1976      :tag "Autodetection setting"
1977      (list
1978       (regexp :tag "Group Regexp")
1979       boolean))
1980    :parameter-document
1981    "Spam autodetection.
1982 Only unseen articles will be examined, unless
1983 spam-autodetect-recheck-messages is set.")
1984
1985   (gnus-define-group-parameter
1986    spam-autodetect-methods
1987    :type list
1988    :parameter-type 
1989    '(choice :tag "Spam autodetection-specific methods"
1990      (const none)
1991      (const default)
1992      (set :tag "Use specific methods"
1993           (variable-item spam-use-blacklist)
1994           (variable-item spam-use-gmane-xref)
1995           (variable-item spam-use-regex-headers)
1996           (variable-item spam-use-regex-body)
1997           (variable-item spam-use-whitelist)
1998           (variable-item spam-use-BBDB)
1999           (variable-item spam-use-ifile)
2000           (variable-item spam-use-spamoracle)
2001           (variable-item spam-use-spamassassin)
2002           (variable-item spam-use-spamassassin-headers)
2003           (variable-item spam-use-stat)
2004           (variable-item spam-use-blackholes)
2005           (variable-item spam-use-hashcash)
2006           (variable-item spam-use-bogofilter-headers)
2007           (variable-item spam-use-bogofilter)))
2008    :function-document
2009    "Methods to be used for autodetection in each group"
2010    :variable gnus-spam-autodetect-methods
2011    :variable-default nil
2012    :variable-document
2013    "*Methods for autodetecting spam per group.
2014 Requires the spam-autodetect parameter.  Only unseen articles
2015 will be examined, unless spam-autodetect-recheck-messages is
2016 set."
2017    :variable-group spam
2018    :variable-type 
2019    '(repeat
2020      :tag "Autodetection methods"
2021      (list
2022       (regexp :tag "Group Regexp")
2023       (choice
2024        (const none)
2025        (const default)
2026        (set :tag "Use specific methods"
2027         (variable-item spam-use-blacklist)
2028         (variable-item spam-use-gmane-xref)
2029         (variable-item spam-use-regex-headers)
2030         (variable-item spam-use-regex-body)
2031         (variable-item spam-use-whitelist)
2032         (variable-item spam-use-BBDB)
2033         (variable-item spam-use-ifile)
2034         (variable-item spam-use-spamoracle)
2035         (variable-item spam-use-stat)
2036         (variable-item spam-use-blackholes)
2037         (variable-item spam-use-hashcash)
2038         (variable-item spam-use-spamassassin)
2039         (variable-item spam-use-spamassassin-headers)
2040         (variable-item spam-use-bogofilter-headers)
2041         (variable-item spam-use-bogofilter)))))
2042      :parameter-document
2043    "Spam autodetection methods.  
2044 Requires the spam-autodetect parameter.  Only unseen articles
2045 will be examined, unless spam-autodetect-recheck-messages is
2046 set.")
2047
2048   (gnus-define-group-parameter
2049    spam-process-destination
2050    :type list
2051    :parameter-type 
2052    '(choice :tag "Destination for spam-processed articles at summary exit"
2053             (string :tag "Move to a group")
2054             (repeat :tag "Move to multiple groups"
2055                     (string :tag "Destination group"))
2056             (const :tag "Expire" nil))
2057    :function-document
2058    "Where spam-processed articles will go at summary exit."
2059    :variable gnus-spam-process-destinations
2060    :variable-default nil
2061    :variable-document
2062    "*Groups in which to explicitly send spam-processed articles to
2063 another group, or expire them (the default).  If non-nil, this should
2064 be a list of group name regexps that should match all groups in which
2065 to do spam-processed article moving, associated with the destination
2066 group or nil for explicit expiration.  This only makes sense for
2067 mail groups."
2068    :variable-group spam
2069    :variable-type 
2070    '(repeat
2071      :tag "Spam-processed articles destination"
2072      (list
2073       (regexp :tag "Group Regexp")
2074       (choice
2075        :tag "Destination for spam-processed articles at summary exit"
2076        (string :tag "Move to a group")
2077        (repeat :tag "Move to multiple groups"
2078                (string :tag "Destination group"))
2079        (const :tag "Expire" nil))))
2080    :parameter-document
2081    "Where spam-processed articles will go at summary exit.")
2082   
2083   (gnus-define-group-parameter
2084    ham-process-destination
2085    :type list
2086    :parameter-type 
2087    '(choice
2088      :tag "Destination for ham articles at summary exit from a spam group"
2089      (string :tag "Move to a group")
2090      (repeat :tag "Move to multiple groups"
2091              (string :tag "Destination group"))
2092      (const :tag "Respool" respool)
2093      (const :tag "Do nothing" nil))
2094    :function-document
2095    "Where ham articles will go at summary exit from a spam group."
2096    :variable gnus-ham-process-destinations
2097    :variable-default nil
2098    :variable-document
2099    "*Groups in which to explicitly send ham articles to
2100 another group, or do nothing (the default).  If non-nil, this should
2101 be a list of group name regexps that should match all groups in which
2102 to do ham article moving, associated with the destination
2103 group or nil for explicit ignoring.  This only makes sense for
2104 mail groups, and only works in spam groups."
2105    :variable-group spam
2106    :variable-type 
2107    '(repeat
2108      :tag "Ham articles destination"
2109      (list
2110       (regexp :tag "Group Regexp")
2111       (choice
2112        :tag "Destination for ham articles at summary exit from spam group"
2113        (string :tag "Move to a group")
2114        (repeat :tag "Move to multiple groups"
2115                 (string :tag "Destination group"))
2116        (const :tag "Respool" respool)
2117        (const :tag "Expire" nil))))
2118    :parameter-document
2119    "Where ham articles will go at summary exit from a spam group.")
2120
2121   (gnus-define-group-parameter
2122    ham-marks
2123    :type 'list
2124    :parameter-type '(list :tag "Ham mark choices"
2125                           (set
2126                            (variable-item gnus-del-mark)
2127                            (variable-item gnus-read-mark)
2128                            (variable-item gnus-ticked-mark)
2129                            (variable-item gnus-killed-mark)
2130                            (variable-item gnus-kill-file-mark)
2131                            (variable-item gnus-low-score-mark)))
2132
2133    :parameter-document
2134    "Marks considered ham (positively not spam).  Such articles will be
2135 processed as ham (non-spam) on group exit.  When nil, the global
2136 spam-ham-marks variable takes precedence."
2137    :variable-default '((".*" ((gnus-del-mark
2138                                gnus-read-mark
2139                                gnus-killed-mark
2140                                gnus-kill-file-mark
2141                                gnus-low-score-mark))))
2142    :variable-group spam
2143    :variable-document
2144    "*Groups in which to explicitly set the ham marks to some value.")
2145
2146   (gnus-define-group-parameter
2147    spam-marks
2148    :type 'list
2149    :parameter-type '(list :tag "Spam mark choices"
2150                           (set
2151                            (variable-item gnus-spam-mark)
2152                            (variable-item gnus-killed-mark)
2153                            (variable-item gnus-kill-file-mark)
2154                            (variable-item gnus-low-score-mark)))
2155
2156    :parameter-document
2157    "Marks considered spam.
2158 Such articles will be processed as spam on group exit.  When nil, the global
2159 spam-spam-marks variable takes precedence."
2160    :variable-default '((".*" ((gnus-spam-mark))))
2161    :variable-group spam
2162    :variable-document
2163    "*Groups in which to explicitly set the spam marks to some value."))
2164
2165 (defcustom gnus-group-uncollapsed-levels 1
2166   "Number of group name elements to leave alone when making a short group name."
2167   :group 'gnus-group-visual
2168   :type 'integer)
2169
2170 (defcustom gnus-group-use-permanent-levels nil
2171   "*If non-nil, once you set a level, Gnus will use this level."
2172   :group 'gnus-group-levels
2173   :type 'boolean)
2174
2175 ;; Hooks.
2176
2177 (defcustom gnus-load-hook nil
2178   "A hook run while Gnus is loaded."
2179   :group 'gnus-start
2180   :type 'hook)
2181
2182 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
2183   "A hook called to apply kill files to a group.
2184 This hook is intended to apply a kill file to the selected newsgroup.
2185 The function `gnus-apply-kill-file' is called by default.
2186
2187 Since a general kill file is too heavy to use only for a few
2188 newsgroups, I recommend you to use a lighter hook function.  For
2189 example, if you'd like to apply a kill file to articles which contains
2190 a string `rmgroup' in subject in newsgroup `control', you can use the
2191 following hook:
2192
2193  (setq gnus-apply-kill-hook
2194       (list
2195         (lambda ()
2196           (cond ((string-match \"control\" gnus-newsgroup-name)
2197                  (gnus-kill \"Subject\" \"rmgroup\")
2198                  (gnus-expunge \"X\"))))))"
2199   :group 'gnus-score-kill
2200   :options '(gnus-apply-kill-file)
2201   :type 'hook)
2202
2203 (defcustom gnus-group-change-level-function nil
2204   "Function run when a group level is changed.
2205 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
2206   :group 'gnus-group-levels
2207   :type 'function)
2208
2209 ;;; Face thingies.
2210
2211 (defcustom gnus-visual
2212   '(summary-highlight group-highlight article-highlight
2213                       mouse-face
2214                       summary-menu group-menu article-menu
2215                       tree-highlight menu highlight
2216                       browse-menu server-menu
2217                       page-marker tree-menu binary-menu pick-menu)
2218   "*Enable visual features.
2219 If `visual' is disabled, there will be no menus and few faces.  Most of
2220 the visual customization options below will be ignored.  Gnus will use
2221 less space and be faster as a result.
2222
2223 This variable can also be a list of visual elements to switch on.  For
2224 instance, to switch off all visual things except menus, you can say:
2225
2226    (setq gnus-visual '(menu))
2227
2228 Valid elements include `summary-highlight', `group-highlight',
2229 `article-highlight', `mouse-face', `summary-menu', `group-menu',
2230 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
2231 `server-menu', `page-marker', `tree-menu', `binary-menu', and`pick-menu'."
2232   :group 'gnus-meta
2233   :group 'gnus-visual
2234   :type '(set (const summary-highlight)
2235               (const group-highlight)
2236               (const article-highlight)
2237               (const mouse-face)
2238               (const summary-menu)
2239               (const group-menu)
2240               (const article-menu)
2241               (const tree-highlight)
2242               (const menu)
2243               (const highlight)
2244               (const browse-menu)
2245               (const server-menu)
2246               (const page-marker)
2247               (const tree-menu)
2248               (const binary-menu)
2249               (const pick-menu)))
2250
2251 ;; Byte-compiler warning.
2252 (defvar gnus-visual)
2253 ;; Find out whether the gnus-visual TYPE is wanted.
2254 (defun gnus-visual-p (&optional type class)
2255   (and gnus-visual                      ; Has to be non-nil, at least.
2256        (if (not type)                   ; We don't care about type.
2257            gnus-visual
2258          (if (listp gnus-visual)        ; It's a list, so we check it.
2259              (or (memq type gnus-visual)
2260                  (memq class gnus-visual))
2261            t))))
2262
2263 (defcustom gnus-mouse-face
2264   (condition-case ()
2265       (if (gnus-visual-p 'mouse-face 'highlight)
2266           (if (boundp 'gnus-mouse-face)
2267               (or gnus-mouse-face 'highlight)
2268             'highlight)
2269         'default)
2270     (error 'highlight))
2271   "*Face used for group or summary buffer mouse highlighting.
2272 The line beneath the mouse pointer will be highlighted with this
2273 face."
2274   :group 'gnus-visual
2275   :type 'face)
2276
2277 (defcustom gnus-article-save-directory gnus-directory
2278   "*Name of the directory articles will be saved in (default \"~/News\")."
2279   :group 'gnus-article-saving
2280   :type 'directory)
2281
2282 (defvar gnus-plugged t
2283   "Whether Gnus is plugged or not.")
2284
2285 (defcustom gnus-agent-cache t
2286   "Controls use of the agent cache while plugged.
2287 When set, Gnus will prefer using the locally stored content rather
2288 than re-fetching it from the server.  You also need to enable
2289 `gnus-agent' for this to have any affect."
2290   :version "21.3"
2291   :group 'gnus-agent
2292   :type 'boolean)
2293
2294 (defcustom gnus-default-charset 'undecided
2295   "Default charset assumed to be used when viewing non-ASCII characters.
2296 This variable is overridden on a group-to-group basis by the
2297 `gnus-group-charset-alist' variable and is only used on groups not
2298 covered by that variable."
2299   :type 'symbol
2300   :group 'gnus-charset)
2301
2302 ;; Fixme: Doc reference to agent.
2303 (defcustom gnus-agent t
2304   "Whether we want to use the Gnus agent or not.
2305
2306 You may customize gnus-agent to disable its use.  However, some
2307 back ends have started to use the agent as a client-side cache.
2308 Disabling the agent may result in noticeable loss of performance."
2309   :version "21.3"
2310   :group 'gnus-agent
2311   :type 'boolean)
2312
2313 (defcustom gnus-other-frame-function 'gnus
2314   "Function called by the command `gnus-other-frame'."
2315   :group 'gnus-start
2316   :type '(choice (function-item gnus)
2317                  (function-item gnus-no-server)
2318                  (function-item gnus-slave)
2319                  (function-item gnus-slave-no-server)))
2320
2321 (defcustom gnus-other-frame-parameters nil
2322   "Frame parameters used by `gnus-other-frame' to create a Gnus frame.
2323 This should be an alist for Emacs, or a plist for XEmacs."
2324   :group 'gnus-start
2325   :type (if (featurep 'xemacs)
2326             '(repeat (list :inline t :format "%v"
2327                            (symbol :tag "Property")
2328                            (sexp :tag "Value")))
2329           '(repeat (cons :format "%v"
2330                          (symbol :tag "Parameter")
2331                          (sexp :tag "Value")))))
2332
2333 (defcustom gnus-user-agent 'emacs-gnus-type
2334   "Which information should be exposed in the User-Agent header.
2335
2336 It can be one of the symbols `gnus' \(show only Gnus version\), `emacs-gnus'
2337 \(show only Emacs and Gnus versions\), `emacs-gnus-config' \(same as
2338 `emacs-gnus' plus system configuration\), `emacs-gnus-type' \(same as
2339 `emacs-gnus' plus system type\) or a custom string.  If you set it to a
2340 string, be sure to use a valid format, see RFC 2616."
2341   :group 'gnus-message
2342   :type '(choice
2343           (item :tag "Show Gnus and Emacs versions and system type"
2344                 emacs-gnus-type)
2345           (item :tag "Show Gnus and Emacs versions and system configuration"
2346                 emacs-gnus-config)
2347           (item :tag "Show Gnus and Emacs versions" emacs-gnus)
2348           (item :tag "Show only Gnus version" gnus)
2349           (string :tag "Other")))
2350
2351 \f
2352 ;;; Internal variables
2353
2354 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
2355 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
2356 (defvar gnus-agent-method-p-cache nil
2357   ; Reset each time gnus-agent-covered-methods is changed else
2358   ; gnus-agent-method-p may mis-report a methods status.
2359   )
2360 (defvar gnus-agent-target-move-group-header "X-Gnus-Agent-Move-To")
2361 (defvar gnus-draft-meta-information-header "X-Draft-From")
2362 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
2363 (defvar gnus-original-article-buffer " *Original Article*")
2364 (defvar gnus-newsgroup-name nil)
2365 (defvar gnus-ephemeral-servers nil)
2366 (defvar gnus-server-method-cache nil)
2367
2368 (defvar gnus-agent-fetching nil
2369   "Whether Gnus agent is in fetching mode.")
2370
2371 (defvar gnus-agent-covered-methods nil
2372   "A list of servers, NOT methods, showing which servers are covered by the agent.")
2373
2374 (defvar gnus-command-method nil
2375   "Dynamically bound variable that says what the current back end is.")
2376
2377 (defvar gnus-current-select-method nil
2378   "The current method for selecting a newsgroup.")
2379
2380 (defvar gnus-tree-buffer "*Tree*"
2381   "Buffer where Gnus thread trees are displayed.")
2382
2383 ;; Dummy variable.
2384 (defvar gnus-use-generic-from nil)
2385
2386 ;; Variable holding the user answers to all method prompts.
2387 (defvar gnus-method-history nil)
2388
2389 ;; Variable holding the user answers to all mail method prompts.
2390 (defvar gnus-mail-method-history nil)
2391
2392 ;; Variable holding the user answers to all group prompts.
2393 (defvar gnus-group-history nil)
2394
2395 (defvar gnus-server-alist nil
2396   "List of available servers.")
2397
2398 (defcustom gnus-cache-directory
2399   (nnheader-concat gnus-directory "cache/")
2400   "*The directory where cached articles will be stored."
2401   :group 'gnus-cache
2402   :type 'directory)
2403
2404 (defvar gnus-predefined-server-alist
2405   `(("cache"
2406      nnspool "cache"
2407      (nnspool-spool-directory ,gnus-cache-directory)
2408      (nnspool-nov-directory ,gnus-cache-directory)
2409      (nnspool-active-file
2410       ,(nnheader-concat gnus-cache-directory "active"))))
2411   "List of predefined (convenience) servers.")
2412
2413 (defvar gnus-topic-indentation "") ;; Obsolete variable.
2414
2415 (defconst gnus-article-mark-lists
2416   '((marked . tick) (replied . reply)
2417     (expirable . expire) (killed . killed)
2418     (bookmarks . bookmark) (dormant . dormant)
2419     (scored . score) (saved . save)
2420     (cached . cache) (downloadable . download)
2421     (unsendable . unsend) (forwarded . forward)
2422     (recent . recent) (seen . seen)))
2423
2424 (defconst gnus-article-special-mark-lists
2425   '((seen range)
2426     (killed range)
2427     (bookmark tuple)
2428     (score tuple)))
2429
2430 ;; Propagate flags to server, with the following exceptions:
2431 ;; `seen' is private to each gnus installation
2432 ;; `cache' is a internal gnus flag for each gnus installation
2433 ;; `download' is a agent flag private to each gnus installation
2434 ;; `unsend' are for nndraft groups only
2435 ;; `score' is not a proper mark
2436 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
2437 (defconst gnus-article-unpropagated-mark-lists
2438   '(seen cache download unsend score bookmark)
2439   "Marks that shouldn't be propagated to back ends.
2440 Typical marks are those that make no sense in a standalone back end,
2441 such as a mark that says whether an article is stored in the cache
2442 \(which doesn't make sense in a standalone back end).")
2443
2444 (defvar gnus-headers-retrieved-by nil)
2445 (defvar gnus-article-reply nil)
2446 (defvar gnus-override-method nil)
2447 (defvar gnus-article-check-size nil)
2448 (defvar gnus-opened-servers nil)
2449
2450 (defvar gnus-current-kill-article nil)
2451
2452 (defvar gnus-have-read-active-file nil)
2453
2454 (defconst gnus-maintainer
2455   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
2456   "The mail address of the Gnus maintainers.")
2457
2458 (defvar gnus-info-nodes
2459   '((gnus-group-mode "(gnus)Group Buffer")
2460     (gnus-summary-mode "(gnus)Summary Buffer")
2461     (gnus-article-mode "(gnus)Article Buffer")
2462     (gnus-server-mode "(gnus)Server Buffer")
2463     (gnus-browse-mode "(gnus)Browse Foreign Server")
2464     (gnus-tree-mode "(gnus)Tree Display"))
2465   "Alist of major modes and related Info nodes.")
2466
2467 (defvar gnus-group-buffer "*Group*")
2468 (defvar gnus-summary-buffer "*Summary*")
2469 (defvar gnus-article-buffer "*Article*")
2470 (defvar gnus-server-buffer "*Server*")
2471
2472 (defvar gnus-slave nil
2473   "Whether this Gnus is a slave or not.")
2474
2475 (defvar gnus-batch-mode nil
2476   "Whether this Gnus is running in batch mode or not.")
2477
2478 (defvar gnus-variable-list
2479   '(gnus-newsrc-options gnus-newsrc-options-n
2480                         gnus-newsrc-last-checked-date
2481                         gnus-newsrc-alist gnus-server-alist
2482                         gnus-killed-list gnus-zombie-list
2483                         gnus-topic-topology gnus-topic-alist
2484                         gnus-format-specs)
2485   "Gnus variables saved in the quick startup file.")
2486
2487 (defvar gnus-newsrc-alist nil
2488   "Assoc list of read articles.
2489 `gnus-newsrc-hashtb' should be kept so that both hold the same information.")
2490
2491 (defvar gnus-registry-alist nil
2492   "Assoc list of registry data.
2493 gnus-registry.el will populate this if it's loaded.")
2494
2495 (defvar gnus-newsrc-hashtb nil
2496   "Hashtable of `gnus-newsrc-alist'.")
2497
2498 (defvar gnus-killed-list nil
2499   "List of killed newsgroups.")
2500
2501 (defvar gnus-killed-hashtb nil
2502   "Hash table equivalent of `gnus-killed-list'.")
2503
2504 (defvar gnus-zombie-list nil
2505   "List of almost dead newsgroups.")
2506
2507 (defvar gnus-description-hashtb nil
2508   "Descriptions of newsgroups.")
2509
2510 (defvar gnus-list-of-killed-groups nil
2511   "List of newsgroups that have recently been killed by the user.")
2512
2513 (defvar gnus-active-hashtb nil
2514   "Hashtable of active articles.")
2515
2516 (defvar gnus-moderated-hashtb nil
2517   "Hashtable of moderated newsgroups.")
2518
2519 ;; Save window configuration.
2520 (defvar gnus-prev-winconf nil)
2521
2522 (defvar gnus-reffed-article-number nil)
2523
2524 ;;; Let the byte-compiler know that we know about this variable.
2525 (defvar rmail-default-rmail-file)
2526
2527 (defvar gnus-dead-summary nil)
2528
2529 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
2530   "Regexp matching invalid groups.")
2531
2532 (defvar gnus-other-frame-object nil
2533   "A frame object which will be created by `gnus-other-frame'.")
2534
2535 ;;; End of variables.
2536
2537 ;; Define some autoload functions Gnus might use.
2538 (eval-and-compile
2539
2540   ;; This little mapcar goes through the list below and marks the
2541   ;; symbols in question as autoloaded functions.
2542   (mapcar
2543    (lambda (package)
2544      (let ((interactive (nth 1 (memq ':interactive package))))
2545        (mapcar
2546         (lambda (function)
2547           (let (keymap)
2548             (when (consp function)
2549               (setq keymap (car (memq 'keymap function)))
2550               (setq function (car function)))
2551             (unless (fboundp function)
2552               (autoload function (car package) nil interactive keymap))))
2553         (if (eq (nth 1 package) ':interactive)
2554             (nthcdr 3 package)
2555           (cdr package)))))
2556    '(("info" :interactive t Info-goto-node)
2557      ("pp" pp-to-string)
2558      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2559      ("ps-print" ps-print-preprint)
2560      ("message" :interactive t
2561       message-send-and-exit message-yank-original)
2562      ("babel" babel-as-string)
2563      ("nnmail" nnmail-split-fancy nnmail-article-group)
2564      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2565      ("rmailout" rmail-output rmail-output-to-rmail-file)
2566      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2567       rmail-show-message rmail-summary-exists
2568       rmail-select-summary rmail-update-summary)
2569      ("gnus-audio" :interactive t gnus-audio-play)
2570      ("gnus-xmas" gnus-xmas-splash)
2571      ("gnus-soup" :interactive t
2572       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2573       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2574      ("nnsoup" nnsoup-pack-replies)
2575      ("score-mode" :interactive t gnus-score-mode)
2576      ("gnus-mh" gnus-summary-save-article-folder
2577       gnus-Folder-save-name gnus-folder-save-name)
2578      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2579      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2580       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2581       gnus-demon-add-disconnection gnus-demon-add-handler
2582       gnus-demon-remove-handler)
2583      ("gnus-demon" :interactive t
2584       gnus-demon-init gnus-demon-cancel)
2585      ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2586       gnus-convert-image-to-gray-x-face gnus-convert-face-to-png
2587       gnus-face-from-file)
2588      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2589       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2590      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2591       gnus-nocem-unwanted-article-p)
2592      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2593       gnus-server-server-name)
2594      ("gnus-srvr" gnus-browse-foreign-server)
2595      ("gnus-cite" :interactive t
2596       gnus-article-highlight-citation gnus-article-hide-citation-maybe
2597       gnus-article-hide-citation gnus-article-fill-cited-article
2598       gnus-article-hide-citation-in-followups)
2599      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2600       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2601       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2602      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2603       gnus-cache-possibly-remove-articles gnus-cache-request-article
2604       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2605       gnus-cache-enter-remove-article gnus-cached-article-p
2606       gnus-cache-open gnus-cache-close gnus-cache-update-article
2607       gnus-cache-articles-in-group)
2608      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2609       gnus-cache-remove-article gnus-summary-insert-cached-articles)
2610      ("gnus-score" :interactive t
2611       gnus-summary-increase-score gnus-summary-set-score
2612       gnus-summary-raise-thread gnus-summary-raise-same-subject
2613       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2614       gnus-summary-lower-thread gnus-summary-lower-same-subject
2615       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2616       gnus-summary-current-score gnus-score-delta-default
2617       gnus-score-flush-cache gnus-score-close
2618       gnus-possibly-score-headers gnus-score-followup-article
2619       gnus-score-followup-thread)
2620      ("gnus-score"
2621       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2622       gnus-current-score-file-nondirectory gnus-score-adaptive
2623       gnus-score-find-trace gnus-score-file-name)
2624      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2625      ("gnus-topic" :interactive t gnus-topic-mode)
2626      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2627       gnus-subscribe-topics)
2628      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2629      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2630      ("gnus-uu" :interactive t
2631       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2632       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2633       gnus-uu-mark-by-regexp gnus-uu-mark-all
2634       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2635       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2636       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2637       gnus-uu-decode-binhex gnus-uu-decode-uu-view
2638       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2639       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2640       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2641       gnus-uu-mark-over gnus-uu-post-news)
2642      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2643      ("gnus-msg" (gnus-summary-send-map keymap)
2644       gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2645      ("gnus-msg" :interactive t
2646       gnus-group-post-news gnus-group-mail gnus-group-news
2647       gnus-summary-post-news gnus-summary-news-other-window
2648       gnus-summary-followup gnus-summary-followup-with-original
2649       gnus-summary-cancel-article gnus-summary-supersede-article
2650       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2651       gnus-summary-mail-forward gnus-summary-mail-other-window
2652       gnus-summary-resend-message gnus-summary-resend-bounced-mail
2653       gnus-summary-wide-reply gnus-summary-followup-to-mail
2654       gnus-summary-followup-to-mail-with-original gnus-bug
2655       gnus-summary-wide-reply-with-original
2656       gnus-summary-post-forward gnus-summary-wide-reply-with-original
2657       gnus-summary-post-forward)
2658      ("gnus-picon" :interactive t gnus-treat-from-picon)
2659      ("smiley" :interactive t smiley-region)
2660      ("gnus-win" gnus-configure-windows gnus-add-configuration)
2661      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2662       gnus-list-of-unread-articles gnus-list-of-read-articles
2663       gnus-offer-save-summaries gnus-make-thread-indent-array
2664       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2665       gnus-summary-skip-intangible gnus-summary-article-number
2666       gnus-data-header gnus-data-find)
2667      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2668       gnus-group-list-groups gnus-group-first-unread-group
2669       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2670       gnus-group-setup-buffer gnus-group-get-new-news
2671       gnus-group-make-help-group gnus-group-update-group
2672       gnus-group-iterate gnus-group-group-name)
2673      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2674       gnus-backlog-remove-article)
2675      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2676       gnus-article-prepare gnus-article-set-window-start
2677       gnus-article-next-page gnus-article-prev-page
2678       gnus-request-article-this-buffer gnus-article-mode
2679       gnus-article-setup-buffer gnus-narrow-to-page
2680       gnus-article-delete-invisible-text gnus-treat-article)
2681      ("gnus-art" :interactive t
2682       gnus-article-hide-headers gnus-article-hide-boring-headers
2683       gnus-article-treat-overstrike
2684       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2685       gnus-article-display-x-face gnus-article-de-quoted-unreadable
2686       gnus-article-de-base64-unreadable
2687       gnus-article-decode-HZ
2688       gnus-article-wash-html
2689       gnus-article-unsplit-urls
2690       gnus-article-hide-pem gnus-article-hide-signature
2691       gnus-article-strip-leading-blank-lines gnus-article-date-local
2692       gnus-article-date-original gnus-article-date-lapsed
2693 ;;      gnus-article-show-all-headers
2694       gnus-article-edit-mode gnus-article-edit-article
2695       gnus-article-edit-done gnus-article-decode-encoded-words
2696       gnus-start-date-timer gnus-stop-date-timer
2697       gnus-mime-view-all-parts)
2698      ("gnus-int" gnus-request-type)
2699      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2700       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2701      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2702       gnus-dup-enter-articles)
2703      ("gnus-range" gnus-copy-sequence)
2704      ("gnus-eform" gnus-edit-form)
2705      ("gnus-move" :interactive t
2706       gnus-group-move-group-to-server gnus-change-server)
2707      ("gnus-logic" gnus-score-advanced)
2708      ("gnus-undo" gnus-undo-mode gnus-undo-register)
2709      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2710       gnus-async-prefetch-article gnus-async-prefetch-remove-group
2711       gnus-async-halt-prefetch)
2712      ("gnus-agent" gnus-open-agent gnus-agent-get-function
2713       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2714       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2715       gnus-summary-set-agent-mark gnus-agent-save-group-info
2716       gnus-agent-request-article gnus-agent-retrieve-headers)
2717      ("gnus-agent" :interactive t
2718       gnus-unplugged gnus-agentize gnus-agent-batch)
2719      ("gnus-vm" :interactive t gnus-summary-save-in-vm
2720       gnus-summary-save-article-vm)
2721      ("compface" uncompface)
2722      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2723      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2724      ("gnus-mlspl" :interactive t gnus-group-split-setup
2725       gnus-group-split-update)
2726      ("gnus-delay" gnus-delay-initialize))))
2727
2728 ;;; gnus-sum.el thingies
2729
2730
2731 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2732   "*The format specification of the lines in the summary buffer.
2733
2734 It works along the same lines as a normal formatting string,
2735 with some simple extensions.
2736
2737 %N   Article number, left padded with spaces (string)
2738 %S   Subject (string)
2739 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
2740 %n   Name of the poster (string)
2741 %a   Extracted name of the poster (string)
2742 %A   Extracted address of the poster (string)
2743 %F   Contents of the From: header (string)
2744 %f   Contents of the From: or To: headers (string)
2745 %x   Contents of the Xref: header (string)
2746 %D   Date of the article (string)
2747 %d   Date of the article (string) in DD-MMM format
2748 %o   Date of the article (string) in YYYYMMDD`T'HHMMSS format
2749 %M   Message-id of the article (string)
2750 %r   References of the article (string)
2751 %c   Number of characters in the article (integer)
2752 %k   Pretty-printed version of the above (string)
2753      For example, \"1.2k\" or \"0.4M\".
2754 %L   Number of lines in the article (integer)
2755 %I   Indentation based on thread level (a string of spaces)
2756 %B   A complex trn-style thread tree (string)
2757      The variables `gnus-sum-thread-*' can be used for customization.
2758 %T   A string with two possible values: 80 spaces if the article
2759      is on thread level two or larger and 0 spaces on level one
2760 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
2761 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2762 %[   Opening bracket (character, \"[\" or \"<\")
2763 %]   Closing bracket (character, \"]\" or \">\")
2764 %>   Spaces of length thread-level (string)
2765 %<   Spaces of length (- 20 thread-level) (string)
2766 %i   Article score (number)
2767 %z   Article zcore (character)
2768 %t   Number of articles under the current thread (number).
2769 %e   Whether the thread is empty or not (character).
2770 %V   Total thread score (number).
2771 %P   The line number (number).
2772 %O   Download mark (character).
2773 %*   If present, indicates desired cursor position
2774      (instead of after first colon).
2775 %u   User defined specifier.  The next character in the format string should
2776      be a letter.  Gnus will call the function gnus-user-format-function-X,
2777      where X is the letter following %u.  The function will be passed the
2778      current header as argument.  The function should return a string, which
2779      will be inserted into the summary just like information from any other
2780      summary specifier.
2781
2782 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2783 with care.  For reasons of efficiency, Gnus will compute what column
2784 these characters will end up in, and \"hard-code\" that.  This means that
2785 it is invalid to have these specs after a variable-length spec.  Well,
2786 you might not be arrested, but your summary buffer will look strange,
2787 which is bad enough.
2788
2789 The smart choice is to have these specs as far to the left as
2790 possible.
2791
2792 This restriction may disappear in later versions of Gnus.
2793
2794 General format specifiers can also be used.
2795 See Info node `(gnus)Formatting Variables'."
2796   :link '(custom-manual "(gnus)Formatting Variables")
2797   :type 'string
2798   :group 'gnus-summary-format)
2799
2800 ;;;
2801 ;;; Skeleton keymaps
2802 ;;;
2803
2804 (defun gnus-suppress-keymap (keymap)
2805   (suppress-keymap keymap)
2806   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2807     (while keys
2808       (define-key keymap (pop keys) 'undefined))))
2809
2810 (defvar gnus-article-mode-map
2811   (let ((keymap (make-sparse-keymap)))
2812     (gnus-suppress-keymap keymap)
2813     keymap))
2814 (defvar gnus-summary-mode-map
2815   (let ((keymap (make-keymap)))
2816     (gnus-suppress-keymap keymap)
2817     keymap))
2818 (defvar gnus-group-mode-map
2819   (let ((keymap (make-keymap)))
2820     (gnus-suppress-keymap keymap)
2821     keymap))
2822
2823 \f
2824
2825 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2826 ;; If you want the cursor to go somewhere else, set these two
2827 ;; functions in some startup hook to whatever you want.
2828 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2829 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2830
2831 ;;; Various macros and substs.
2832
2833 (defun gnus-header-from (header)
2834   (mail-header-from header))
2835
2836 (defmacro gnus-gethash (string hashtable)
2837   "Get hash value of STRING in HASHTABLE."
2838   `(symbol-value (intern-soft ,string ,hashtable)))
2839
2840 (defmacro gnus-gethash-safe (string hashtable)
2841   "Get hash value of STRING in HASHTABLE.
2842 Return nil if not defined."
2843   `(let ((sym (intern-soft ,string ,hashtable)))
2844      (and (boundp sym) (symbol-value sym))))
2845
2846 (defmacro gnus-sethash (string value hashtable)
2847   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
2848   `(set (intern ,string ,hashtable) ,value))
2849 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2850
2851 (defmacro gnus-group-unread (group)
2852   "Get the currently computed number of unread articles in GROUP."
2853   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2854
2855 (defmacro gnus-group-entry (group)
2856   "Get the newsrc entry for GROUP."
2857   `(gnus-gethash ,group gnus-newsrc-hashtb))
2858
2859 (defmacro gnus-active (group)
2860   "Get active info on GROUP."
2861   `(gnus-gethash ,group gnus-active-hashtb))
2862
2863 (defmacro gnus-set-active (group active)
2864   "Set GROUP's active info."
2865   `(gnus-sethash ,group ,active gnus-active-hashtb))
2866
2867 ;; Info access macros.
2868
2869 (defmacro gnus-info-group (info)
2870   `(nth 0 ,info))
2871 (defmacro gnus-info-rank (info)
2872   `(nth 1 ,info))
2873 (defmacro gnus-info-read (info)
2874   `(nth 2 ,info))
2875 (defmacro gnus-info-marks (info)
2876   `(nth 3 ,info))
2877 (defmacro gnus-info-method (info)
2878   `(nth 4 ,info))
2879 (defmacro gnus-info-params (info)
2880   `(nth 5 ,info))
2881
2882 (defmacro gnus-info-level (info)
2883   `(let ((rank (gnus-info-rank ,info)))
2884      (if (consp rank)
2885          (car rank)
2886        rank)))
2887 (defmacro gnus-info-score (info)
2888   `(let ((rank (gnus-info-rank ,info)))
2889      (or (and (consp rank) (cdr rank)) 0)))
2890
2891 (defmacro gnus-info-set-group (info group)
2892   `(setcar ,info ,group))
2893 (defmacro gnus-info-set-rank (info rank)
2894   `(setcar (nthcdr 1 ,info) ,rank))
2895 (defmacro gnus-info-set-read (info read)
2896   `(setcar (nthcdr 2 ,info) ,read))
2897 (defmacro gnus-info-set-marks (info marks &optional extend)
2898   (if extend
2899       `(gnus-info-set-entry ,info ,marks 3)
2900     `(setcar (nthcdr 3 ,info) ,marks)))
2901 (defmacro gnus-info-set-method (info method &optional extend)
2902   (if extend
2903       `(gnus-info-set-entry ,info ,method 4)
2904     `(setcar (nthcdr 4 ,info) ,method)))
2905 (defmacro gnus-info-set-params (info params &optional extend)
2906   (if extend
2907       `(gnus-info-set-entry ,info ,params 5)
2908     `(setcar (nthcdr 5 ,info) ,params)))
2909
2910 (defun gnus-info-set-entry (info entry number)
2911   ;; Extend the info until we have enough elements.
2912   (while (<= (length info) number)
2913     (nconc info (list nil)))
2914   ;; Set the entry.
2915   (setcar (nthcdr number info) entry))
2916
2917 (defmacro gnus-info-set-level (info level)
2918   `(let ((rank (cdr ,info)))
2919      (if (consp (car rank))
2920          (setcar (car rank) ,level)
2921        (setcar rank ,level))))
2922 (defmacro gnus-info-set-score (info score)
2923   `(let ((rank (cdr ,info)))
2924      (if (consp (car rank))
2925          (setcdr (car rank) ,score)
2926        (setcar rank (cons (car rank) ,score)))))
2927
2928 (defmacro gnus-get-info (group)
2929   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2930
2931 ;;; Load the compatibility functions.
2932
2933 (require 'gnus-ems)
2934
2935 \f
2936 ;;;
2937 ;;; Shutdown
2938 ;;;
2939
2940 (defvar gnus-shutdown-alist nil)
2941
2942 (defun gnus-add-shutdown (function &rest symbols)
2943   "Run FUNCTION whenever one of SYMBOLS is shut down."
2944   (push (cons function symbols) gnus-shutdown-alist))
2945
2946 (defun gnus-shutdown (symbol)
2947   "Shut down everything that waits for SYMBOL."
2948   (let ((alist gnus-shutdown-alist)
2949         entry)
2950     (while (setq entry (pop alist))
2951       (when (memq symbol (cdr entry))
2952         (funcall (car entry))))))
2953
2954 \f
2955 ;;;
2956 ;;; Gnus Utility Functions
2957 ;;;
2958
2959 (defun gnus-find-subscribed-addresses ()
2960   "Return a regexp matching the addresses of all subscribed mail groups.
2961 It consists of the `to-address' or `to-list' parameter of all groups
2962 with a `subscribed' parameter."
2963   (let (group address addresses)
2964     (dolist (entry (cdr gnus-newsrc-alist))
2965       (setq group (car entry))
2966       (when (gnus-parameter-subscribed group)
2967         (setq address (mail-strip-quoted-names
2968                        (or (gnus-group-fast-parameter group 'to-address)
2969                            (gnus-group-fast-parameter group 'to-list))))
2970         (when address
2971           (add-to-list 'addresses address))))
2972     (when addresses
2973       (list (mapconcat 'regexp-quote addresses "\\|")))))
2974
2975 (defmacro gnus-string-or (&rest strings)
2976   "Return the first element of STRINGS that is a non-blank string.
2977 STRINGS will be evaluated in normal `or' order."
2978   `(gnus-string-or-1 ',strings))
2979
2980 (defun gnus-string-or-1 (strings)
2981   (let (string)
2982     (while strings
2983       (setq string (eval (pop strings)))
2984       (if (string-match "^[ \t]*$" string)
2985           (setq string nil)
2986         (setq strings nil)))
2987     string))
2988
2989 (defun gnus-version (&optional arg)
2990   "Version number of this version of Gnus.
2991 If ARG, insert string at point."
2992   (interactive "P")
2993   (if arg
2994       (insert (message gnus-version))
2995     (message gnus-version)))
2996
2997 (defun gnus-continuum-version (&optional version)
2998   "Return VERSION as a floating point number."
2999   (interactive)
3000   (unless version
3001     (setq version gnus-version))
3002   (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
3003             (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
3004     (let ((alpha (and (match-beginning 1) (match-string 1 version)))
3005           (number (match-string 2 version))
3006           major minor least)
3007       (unless (string-match
3008                "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
3009         (error "Invalid version string: %s" version))
3010       (setq major (string-to-number (match-string 1 number))
3011             minor (string-to-number (match-string 2 number))
3012             least (if (match-beginning 3)
3013                       (string-to-number (match-string 3 number))
3014                     0))
3015       (string-to-number
3016        (if (zerop major)
3017              (format "%s00%02d%02d"
3018                      (if (member alpha '("(ding)" "d"))
3019                          "4.99"
3020                        (+ 5 (* 0.02
3021                                (abs
3022                                 (- (mm-char-int (aref (downcase alpha) 0))
3023                                    (mm-char-int ?t))))
3024                           -0.01))
3025                      minor least)
3026          (format "%d.%02d%02d" major minor least))))))
3027
3028 (defun gnus-info-find-node (&optional nodename)
3029   "Find Info documentation of Gnus."
3030   (interactive)
3031   ;; Enlarge info window if needed.
3032   (let (gnus-info-buffer)
3033     (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
3034     (setq gnus-info-buffer (current-buffer))
3035     (gnus-configure-windows 'info)))
3036
3037 ;;;
3038 ;;; gnus-interactive
3039 ;;;
3040
3041 (defvar gnus-current-prefix-symbol nil
3042   "Current prefix symbol.")
3043
3044 (defvar gnus-current-prefix-symbols nil
3045   "List of current prefix symbols.")
3046
3047 (defun gnus-interactive (string &optional params)
3048   "Return a list that can be fed to `interactive'.
3049 See `interactive' for full documentation.
3050
3051 Adds the following specs:
3052
3053 y -- The current symbolic prefix.
3054 Y -- A list of the current symbolic prefix(es).
3055 A -- Article number.
3056 H -- Article header.
3057 g -- Group name."
3058   (let ((i 0)
3059         out c prompt)
3060     (while (< i (length string))
3061       (string-match ".\\([^\n]*\\)\n?" string i)
3062       (setq c (aref string i))
3063       (when (match-end 1)
3064         (setq prompt (match-string 1 string)))
3065       (setq i (match-end 0))
3066       ;; We basically emulate just about everything that
3067       ;; `interactive' does, but add the specs listed above.
3068       (push
3069        (cond
3070         ((= c ?a)
3071          (completing-read prompt obarray 'fboundp t))
3072         ((= c ?b)
3073          (read-buffer prompt (current-buffer) t))
3074         ((= c ?B)
3075          (read-buffer prompt (other-buffer (current-buffer))))
3076         ((= c ?c)
3077          (read-char))
3078         ((= c ?C)
3079          (completing-read prompt obarray 'commandp t))
3080         ((= c ?d)
3081          (point))
3082         ((= c ?D)
3083          (read-file-name prompt nil default-directory 'lambda))
3084         ((= c ?f)
3085          (read-file-name prompt nil nil 'lambda))
3086         ((= c ?F)
3087          (read-file-name prompt))
3088         ((= c ?k)
3089          (read-key-sequence prompt))
3090         ((= c ?K)
3091          (error "Not implemented spec"))
3092         ((= c ?e)
3093          (error "Not implemented spec"))
3094         ((= c ?m)
3095          (mark))
3096         ((= c ?N)
3097          (error "Not implemented spec"))
3098         ((= c ?n)
3099          (string-to-number (read-from-minibuffer prompt)))
3100         ((= c ?p)
3101          (prefix-numeric-value current-prefix-arg))
3102         ((= c ?P)
3103          current-prefix-arg)
3104         ((= c ?r)
3105          'gnus-prefix-nil)
3106         ((= c ?s)
3107          (read-string prompt))
3108         ((= c ?S)
3109          (intern (read-string prompt)))
3110         ((= c ?v)
3111          (read-variable prompt))
3112         ((= c ?x)
3113          (read-minibuffer prompt))
3114         ((= c ?x)
3115          (eval-minibuffer prompt))
3116         ;; And here the new specs come.
3117         ((= c ?y)
3118          gnus-current-prefix-symbol)
3119         ((= c ?Y)
3120          gnus-current-prefix-symbols)
3121         ((= c ?g)
3122          (gnus-group-group-name))
3123         ((= c ?A)
3124          (gnus-summary-skip-intangible)
3125          (or (get-text-property (point) 'gnus-number)
3126              (gnus-summary-last-subject)))
3127         ((= c ?H)
3128          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
3129         (t
3130          (error "Non-implemented spec")))
3131        out)
3132       (cond
3133        ((= c ?r)
3134         (push (if (< (point) (mark)) (point) (mark)) out)
3135         (push (if (> (point) (mark)) (point) (mark)) out))))
3136     (setq out (delq 'gnus-prefix-nil out))
3137     (nreverse out)))
3138
3139 (defun gnus-symbolic-argument (&optional arg)
3140   "Read a symbolic argument and a command, and then execute command."
3141   (interactive "P")
3142   (let* ((in-command (this-command-keys))
3143          (command in-command)
3144          gnus-current-prefix-symbols
3145          gnus-current-prefix-symbol
3146          syms)
3147     (while (equal in-command command)
3148       (message "%s-" (key-description (this-command-keys)))
3149       (push (intern (char-to-string (read-char))) syms)
3150       (setq command (read-key-sequence nil t)))
3151     (setq gnus-current-prefix-symbols (nreverse syms)
3152           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
3153     (call-interactively (key-binding command t))))
3154
3155 ;;; More various functions.
3156
3157 (defsubst gnus-check-backend-function (func group)
3158   "Check whether GROUP supports function FUNC.
3159 GROUP can either be a string (a group name) or a select method."
3160   (ignore-errors
3161     (let ((method (if (stringp group)
3162                       (car (gnus-find-method-for-group group))
3163                     group)))
3164       (unless (featurep method)
3165         (require method))
3166       (fboundp (intern (format "%s-%s" method func))))))
3167
3168 (defun gnus-group-read-only-p (&optional group)
3169   "Check whether GROUP supports editing or not.
3170 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
3171 that that variable is buffer-local to the summary buffers."
3172   (let ((group (or group gnus-newsgroup-name)))
3173     (not (gnus-check-backend-function 'request-replace-article group))))
3174
3175 (defun gnus-virtual-group-p (group)
3176   "Say whether GROUP is virtual or not."
3177   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
3178                         gnus-valid-select-methods)))
3179
3180 (defun gnus-news-group-p (group &optional article)
3181   "Return non-nil if GROUP (and ARTICLE) come from a news server."
3182   (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
3183          t)                             ;is news of course.
3184         ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
3185          nil)                           ;must be mail then.
3186         ((vectorp article)              ;Has header info.
3187          (eq (gnus-request-type group (mail-header-id article)) 'news))
3188         ((null article)                 ;Hasn't header info
3189          (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
3190         ((< article 0)                  ;Virtual message
3191          nil)                           ;we don't know, guess mail.
3192         (t                              ;Has positive number
3193          (eq (gnus-request-type group article) 'news)))) ;use it.
3194
3195 ;; Returns a list of writable groups.
3196 (defun gnus-writable-groups ()
3197   (let ((alist gnus-newsrc-alist)
3198         groups group)
3199     (while (setq group (car (pop alist)))
3200       (unless (gnus-group-read-only-p group)
3201         (push group groups)))
3202     (nreverse groups)))
3203
3204 ;; Check whether to use long file names.
3205 (defun gnus-use-long-file-name (symbol)
3206   ;; The variable has to be set...
3207   (and gnus-use-long-file-name
3208        ;; If it isn't a list, then we return t.
3209        (or (not (listp gnus-use-long-file-name))
3210            ;; If it is a list, and the list contains `symbol', we
3211            ;; return nil.
3212            (not (memq symbol gnus-use-long-file-name)))))
3213
3214 ;; Generate a unique new group name.
3215 (defun gnus-generate-new-group-name (leaf)
3216   (let ((name leaf)
3217         (num 0))
3218     (while (gnus-group-entry name)
3219       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
3220     name))
3221
3222 (defun gnus-ephemeral-group-p (group)
3223   "Say whether GROUP is ephemeral or not."
3224   (gnus-group-get-parameter group 'quit-config t))
3225
3226 (defun gnus-group-quit-config (group)
3227   "Return the quit-config of GROUP."
3228   (gnus-group-get-parameter group 'quit-config t))
3229
3230 (defun gnus-kill-ephemeral-group (group)
3231   "Remove ephemeral GROUP from relevant structures."
3232   (gnus-sethash group nil gnus-newsrc-hashtb))
3233
3234 (defun gnus-simplify-mode-line ()
3235   "Make mode lines a bit simpler."
3236   (setq mode-line-modified (cdr gnus-mode-line-modified))
3237   (when (listp mode-line-format)
3238     (make-local-variable 'mode-line-format)
3239     (setq mode-line-format (copy-sequence mode-line-format))
3240     (when (equal (nth 3 mode-line-format) "   ")
3241       (setcar (nthcdr 3 mode-line-format) " "))))
3242
3243 ;;; Servers and groups.
3244
3245 (defsubst gnus-server-add-address (method)
3246   (let ((method-name (symbol-name (car method))))
3247     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
3248              (not (assq (intern (concat method-name "-address")) method))
3249              (memq 'physical-address (assq (car method)
3250                                            gnus-valid-select-methods)))
3251         (append method (list (list (intern (concat method-name "-address"))
3252                                    (nth 1 method))))
3253       method)))
3254
3255 (defsubst gnus-method-to-server (method)
3256   (catch 'server-name
3257     (setq method (or method gnus-select-method))
3258
3259     ;; Perhaps it is already in the cache.
3260     (mapc (lambda (name-method)
3261             (if (equal (cdr name-method) method)
3262                 (throw 'server-name (car name-method))))
3263           gnus-server-method-cache)
3264
3265     (mapc
3266      (lambda (server-alist)
3267        (mapc (lambda (name-method)
3268                (when (gnus-methods-equal-p (cdr name-method) method)
3269                  (unless (member name-method gnus-server-method-cache)
3270                    (push name-method gnus-server-method-cache))
3271                  (throw 'server-name (car name-method))))
3272              server-alist))
3273      (let ((alists (list gnus-server-alist
3274                          gnus-predefined-server-alist)))
3275        (if gnus-select-method
3276            (push (list (cons "native" gnus-select-method)) alists))
3277        alists))
3278
3279     (let* ((name (if (member (cadr method) '(nil ""))
3280                      (format "%s" (car method))
3281                    (format "%s:%s" (car method) (cadr method))))
3282            (name-method (cons name method)))
3283       (unless (member name-method gnus-server-method-cache)
3284         (push name-method gnus-server-method-cache))
3285       name)))
3286
3287 (defsubst gnus-server-to-method (server)
3288   "Map virtual server names to select methods."
3289   (or (and server (listp server) server)
3290       (cdr (assoc server gnus-server-method-cache))
3291       (let ((result
3292              (or
3293               ;; Perhaps this is the native server?
3294               (and (equal server "native") gnus-select-method)
3295               ;; It should be in the server alist.
3296               (cdr (assoc server gnus-server-alist))
3297               ;; It could be in the predefined server alist.
3298               (cdr (assoc server gnus-predefined-server-alist))
3299               ;; If not, we look through all the opened server
3300               ;; to see whether we can find it there.
3301               (let ((opened gnus-opened-servers))
3302                 (while (and opened
3303                             (not (equal server (format "%s:%s" (caaar opened)
3304                                                        (cadaar opened)))))
3305                   (pop opened))
3306                 (caar opened))
3307               ;; It could be a named method, search all servers
3308               (let ((servers gnus-secondary-select-methods))
3309                 (while (and servers
3310                             (not (equal server (format "%s:%s" (caar servers)
3311                                                        (cadar servers)))))
3312                   (pop servers))
3313                 (car servers))
3314               ;; This could be some sort of foreign server that I
3315               ;; simply haven't opened (yet).  Do a brute-force scan
3316               ;; of the entire gnus-newsrc-alist for the server name
3317               ;; of every method.  As a side-effect, loads the
3318               ;; gnus-server-method-cache so this only happens once,
3319               ;; if at all.
3320               (let (match)
3321                 (mapcar 
3322                  (lambda (info)
3323                    (let ((info-method (gnus-info-method info)))
3324                      (unless (stringp info-method)
3325                        (let ((info-server (gnus-method-to-server info-method)))
3326                          (when (equal server info-server)
3327                            (setq match info-method))))))
3328                  (cdr gnus-newsrc-alist))
3329                 match))))
3330         (when result
3331           (push (cons server result) gnus-server-method-cache))
3332         result)))
3333
3334 (defsubst gnus-server-get-method (group method)
3335   ;; Input either a server name, and extended server name, or a
3336   ;; select method, and return a select method.
3337   (cond ((stringp method)
3338          (gnus-server-to-method method))
3339         ((equal method gnus-select-method)
3340          gnus-select-method)
3341         ((and (stringp (car method))
3342               group)
3343          (gnus-server-extend-method group method))
3344         ((and method
3345               (not group)
3346               (equal (cadr method) ""))
3347          method)
3348         (t
3349          (gnus-server-add-address method))))
3350
3351 (defmacro gnus-method-equal (ss1 ss2)
3352   "Say whether two servers are equal."
3353   `(let ((s1 ,ss1)
3354          (s2 ,ss2))
3355      (or (equal s1 s2)
3356          (and (= (length s1) (length s2))
3357               (progn
3358                 (while (and s1 (member (car s1) s2))
3359                   (setq s1 (cdr s1)))
3360                 (null s1))))))
3361
3362 (defun gnus-methods-equal-p (m1 m2)
3363   (let ((m1 (or m1 gnus-select-method))
3364         (m2 (or m2 gnus-select-method)))
3365     (or (equal m1 m2)
3366         (and (eq (car m1) (car m2))
3367              (or (not (memq 'address (assoc (symbol-name (car m1))
3368                                             gnus-valid-select-methods)))
3369                  (equal (nth 1 m1) (nth 1 m2)))))))
3370
3371 (defun gnus-server-equal (m1 m2)
3372   "Say whether two methods are equal."
3373   (let ((m1 (cond ((null m1) gnus-select-method)
3374                   ((stringp m1) (gnus-server-to-method m1))
3375                   (t m1)))
3376         (m2 (cond ((null m2) gnus-select-method)
3377                   ((stringp m2) (gnus-server-to-method m2))
3378                   (t m2))))
3379     (gnus-method-equal m1 m2)))
3380
3381 (defun gnus-servers-using-backend (backend)
3382   "Return a list of known servers using BACKEND."
3383   (let ((opened gnus-opened-servers)
3384         out)
3385     (while opened
3386       (when (eq backend (caaar opened))
3387         (push (caar opened) out))
3388       (pop opened))
3389     out))
3390
3391 (defun gnus-archive-server-wanted-p ()
3392   "Say whether the user wants to use the archive server."
3393   (cond
3394    ((or (not gnus-message-archive-method)
3395         (not gnus-message-archive-group))
3396     nil)
3397    ((and gnus-message-archive-method gnus-message-archive-group)
3398     t)
3399    (t
3400     (let ((active (cadr (assq 'nnfolder-active-file
3401                               gnus-message-archive-method))))
3402       (and active
3403            (file-exists-p active))))))
3404
3405 (defsubst gnus-method-to-server-name (method)
3406   (concat
3407    (format "%s" (car method))
3408    (when (and
3409           (or (assoc (format "%s" (car method))
3410                      (gnus-methods-using 'address))
3411               (gnus-server-equal method gnus-message-archive-method))
3412           (nth 1 method)
3413           (not (string= (nth 1 method) "")))
3414      (concat "+" (nth 1 method)))))
3415
3416 (defsubst gnus-method-to-full-server-name (method)
3417   (format "%s+%s" (car method) (nth 1 method)))
3418
3419 (defun gnus-group-prefixed-name (group method &optional full)
3420   "Return the whole name from GROUP and METHOD.
3421 Call with full set to get the fully qualified group name (even if the
3422 server is native)."
3423   (when (stringp method)
3424     (setq method (gnus-server-to-method method)))
3425   (if (or (not method)
3426           (and (not full) (gnus-server-equal method "native"))
3427           ;;;!!! This might not be right.  We'll see...
3428           ;(string-match ":" group)
3429           )
3430       group
3431     (concat (gnus-method-to-server-name method) ":" group)))
3432
3433 (defun gnus-group-guess-prefixed-name (group)
3434   "Guess the whole name from GROUP and METHOD."
3435   (gnus-group-prefixed-name group (gnus-find-method-for-group
3436                                group)))
3437
3438 (defun gnus-group-full-name (group method)
3439   "Return the full name from GROUP and METHOD, even if the method is native."
3440   (gnus-group-prefixed-name group method t))
3441
3442 (defun gnus-group-guess-full-name (group)
3443   "Guess the full name from GROUP, even if the method is native."
3444   (if (gnus-group-prefixed-p group)
3445       group
3446     (gnus-group-full-name group (gnus-find-method-for-group group))))
3447
3448 (defun gnus-group-guess-full-name-from-command-method (group)
3449   "Guess the full name from GROUP, even if the method is native."
3450   (if (gnus-group-prefixed-p group)
3451       group
3452     (gnus-group-full-name group gnus-command-method)))
3453
3454 (defun gnus-group-real-prefix (group)
3455   "Return the prefix of the current group name."
3456   (if (stringp group)
3457       (if (string-match "^[^:]+:" group)
3458           (substring group 0 (match-end 0))
3459         "")
3460     nil))
3461
3462 (defun gnus-group-short-name (group)
3463   "Return the short group name."
3464   (let ((prefix (gnus-group-real-prefix group)))
3465     (if (< 0 (length prefix))
3466         (substring group (length prefix) nil)
3467       group)))
3468
3469 (defun gnus-group-prefixed-p (group)
3470   "Return the prefix of the current group name."
3471   (< 0 (length (gnus-group-real-prefix group))))
3472
3473 (defun gnus-summary-buffer-name (group)
3474   "Return the summary buffer name of GROUP."
3475   (concat "*Summary " (gnus-group-decoded-name group) "*"))
3476
3477 (defun gnus-group-method (group)
3478   "Return the server or method used for selecting GROUP.
3479 You should probably use `gnus-find-method-for-group' instead."
3480   (let ((prefix (gnus-group-real-prefix group)))
3481     (if (equal prefix "")
3482         gnus-select-method
3483       (let ((servers gnus-opened-servers)
3484             (server "")
3485             backend possible found)
3486         (if (string-match "^[^\\+]+\\+" prefix)
3487             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
3488                   server (substring prefix (match-end 0) (1- (length prefix))))
3489           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
3490         (while servers
3491           (when (eq (caaar servers) backend)
3492             (setq possible (caar servers))
3493             (when (equal (cadaar servers) server)
3494               (setq found (caar servers))))
3495           (pop servers))
3496         (or (car (rassoc found gnus-server-alist))
3497             found
3498             (car (rassoc possible gnus-server-alist))
3499             possible
3500             (list backend server))))))
3501
3502 (defsubst gnus-native-method-p (method)
3503   "Return whether METHOD is the native select method."
3504   (gnus-method-equal method gnus-select-method))
3505
3506 (defsubst gnus-secondary-method-p (method)
3507   "Return whether METHOD is a secondary select method."
3508   (let ((methods gnus-secondary-select-methods)
3509         (gmethod (inline (gnus-server-get-method nil method))))
3510     (while (and methods
3511                 (not (gnus-method-equal
3512                       (inline (gnus-server-get-method nil (car methods)))
3513                       gmethod)))
3514       (setq methods (cdr methods)))
3515     methods))
3516
3517 (defun gnus-method-simplify (method)
3518   "Return the shortest uniquely identifying string or method for METHOD."
3519   (cond ((stringp method)
3520          method)
3521         ((gnus-native-method-p method)
3522          nil)
3523         ((gnus-secondary-method-p method)
3524          (format "%s:%s" (nth 0 method) (nth 1 method)))
3525         (t
3526          method)))
3527
3528 (defun gnus-groups-from-server (server)
3529   "Return a list of all groups that are fetched from SERVER."
3530   (let ((alist (cdr gnus-newsrc-alist))
3531         info groups)
3532     (while (setq info (pop alist))
3533       (when (gnus-server-equal (gnus-info-method info) server)
3534         (push (gnus-info-group info) groups)))
3535     (sort groups 'string<)))
3536
3537 (defun gnus-group-foreign-p (group)
3538   "Say whether a group is foreign or not."
3539   (and (not (gnus-group-native-p group))
3540        (not (gnus-group-secondary-p group))))
3541
3542 (defun gnus-group-native-p (group)
3543   "Say whether the group is native or not."
3544   (not (string-match ":" group)))
3545
3546 (defun gnus-group-secondary-p (group)
3547   "Say whether the group is secondary or not."
3548   (gnus-secondary-method-p (gnus-find-method-for-group group)))
3549
3550 (defun gnus-parameters-get-parameter (group)
3551   "Return the group parameters for GROUP from `gnus-parameters'."
3552   (let (params-list)
3553     (dolist (elem gnus-parameters)
3554       (when (string-match (car elem) group)
3555         (setq params-list
3556               (nconc (gnus-expand-group-parameters
3557                       (car elem) (cdr elem) group)
3558                      params-list))))
3559     params-list))
3560
3561 (defun gnus-expand-group-parameter (match value group)
3562   "Use MATCH to expand VALUE in GROUP."
3563   (with-temp-buffer
3564     (insert group)
3565     (goto-char (point-min))
3566     (while (re-search-forward match nil t)
3567       (replace-match value))
3568     (buffer-string)))
3569
3570 (defun gnus-expand-group-parameters (match parameters group)
3571   "Go through PARAMETERS and expand them according to the match data."
3572   (let (new)
3573     (dolist (elem parameters)
3574       (if (and (stringp (cdr elem))
3575                (string-match "\\\\[0-9&]" (cdr elem)))
3576           (push (cons (car elem)
3577                       (gnus-expand-group-parameter match (cdr elem) group))
3578                 new)
3579         (push elem new)))
3580     new))
3581
3582 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
3583   "For GROUP, return the value of SYMBOL.
3584
3585 You should call this in the `gnus-group-buffer' buffer.
3586 The function `gnus-group-find-parameter' will do that for you."
3587   ;; The speed trick:  No cons'ing and quit early.
3588   (let* ((params (funcall gnus-group-get-parameter-function group))
3589          ;; Start easy, check the "real" group parameters.
3590          (simple-results
3591           (gnus-group-parameter-value params symbol allow-list t)))
3592     (if simple-results
3593         ;; Found results; return them.
3594         (car simple-results)
3595       ;; We didn't found it there, try `gnus-parameters'.
3596       (let ((result nil)
3597             (head nil)
3598             (tail gnus-parameters))
3599         ;; A good old-fashioned non-cl loop.
3600         (while tail
3601           (setq head (car tail)
3602                 tail (cdr tail))
3603           ;; The car is regexp matching for matching the group name.
3604           (when (string-match (car head) group)
3605             ;; The cdr is the parameters.
3606             (setq result (gnus-group-parameter-value (cdr head)
3607                                                      symbol allow-list))
3608             (when result
3609               ;; Expand if necessary.
3610               (if (and (stringp result) (string-match "\\\\[0-9&]" result))
3611                   (setq result (gnus-expand-group-parameter (car head)
3612                                                             result group)))
3613               ;; Exit the loop early.
3614               (setq tail nil))))
3615         ;; Done.
3616         result))))
3617
3618 (defun gnus-group-find-parameter (group &optional symbol allow-list)
3619   "Return the group parameters for GROUP.
3620 If SYMBOL, return the value of that symbol in the group parameters.
3621
3622 If you call this function inside a loop, consider using the faster
3623 `gnus-group-fast-parameter' instead."
3624   (save-excursion
3625     (set-buffer gnus-group-buffer)
3626     (if symbol
3627         (gnus-group-fast-parameter group symbol allow-list)
3628       (nconc
3629        (copy-sequence
3630         (funcall gnus-group-get-parameter-function group))
3631        (gnus-parameters-get-parameter group)))))
3632
3633 (defun gnus-group-get-parameter (group &optional symbol allow-list)
3634   "Return the group parameters for GROUP.
3635 If SYMBOL, return the value of that symbol in the group parameters.
3636 Most functions should use `gnus-group-find-parameter', which
3637 also examines the topic parameters."
3638   (let ((params (gnus-info-params (gnus-get-info group))))
3639     (if symbol
3640         (gnus-group-parameter-value params symbol allow-list)
3641       params)))
3642
3643 (defun gnus-group-parameter-value (params symbol &optional
3644                                           allow-list present-p)
3645   "Return the value of SYMBOL in group PARAMS."
3646   ;; We only wish to return group parameters (dotted lists) and
3647   ;; not local variables, which may have the same names.
3648   ;; But first we handle single elements...
3649   (or (car (memq symbol params))
3650       ;; Handle alist.
3651       (let (elem)
3652         (catch 'found
3653           (while (setq elem (pop params))
3654             (when (and (consp elem)
3655                        (eq (car elem) symbol)
3656                        (or allow-list
3657                            (atom (cdr elem))))
3658               (throw 'found (if present-p (list (cdr elem))
3659                               (cdr elem)))))))))
3660
3661 (defun gnus-group-add-parameter (group param)
3662   "Add parameter PARAM to GROUP."
3663   (let ((info (gnus-get-info group)))
3664     (when info
3665       (gnus-group-remove-parameter group (if (consp param) (car param) param))
3666       ;; Cons the new param to the old one and update.
3667       (gnus-group-set-info (cons param (gnus-info-params info))
3668                            group 'params))))
3669
3670 (defun gnus-group-set-parameter (group name value)
3671   "Set parameter NAME to VALUE in GROUP."
3672   (let ((info (gnus-get-info group)))
3673     (when info
3674       (gnus-group-remove-parameter group name)
3675       (let ((old-params (gnus-info-params info))
3676             (new-params (list (cons name value))))
3677         (while old-params
3678           (when (or (not (listp (car old-params)))
3679                     (not (eq (caar old-params) name)))
3680             (setq new-params (append new-params (list (car old-params)))))
3681           (setq old-params (cdr old-params)))
3682         (gnus-group-set-info new-params group 'params)))))
3683
3684 (defun gnus-group-remove-parameter (group name)
3685   "Remove parameter NAME from GROUP."
3686   (let ((info (gnus-get-info group)))
3687     (when info
3688       (let ((params (gnus-info-params info)))
3689         (when params
3690           (setq params (delq name params))
3691           (while (assq name params)
3692             (gnus-pull name params))
3693           (gnus-info-set-params info params))))))
3694
3695 (defun gnus-group-add-score (group &optional score)
3696   "Add SCORE to the GROUP score.
3697 If SCORE is nil, add 1 to the score of GROUP."
3698   (let ((info (gnus-get-info group)))
3699     (when info
3700       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3701
3702 (defun gnus-short-group-name (group &optional levels)
3703   "Collapse GROUP name LEVELS.
3704 Select methods are stripped and any remote host name is stripped down to
3705 just the host name."
3706   (let* ((name "")
3707          (foreign "")
3708          (depth 0)
3709          (skip 1)
3710          (levels (or levels
3711                      gnus-group-uncollapsed-levels
3712                      (progn
3713                        (while (string-match "\\." group skip)
3714                          (setq skip (match-end 0)
3715                                depth (+ depth 1)))
3716                        depth))))
3717     ;; Separate foreign select method from group name and collapse.
3718    ;; If method contains a server, collapse to non-domain server name,
3719     ;; otherwise collapse to select method.
3720     (let* ((colon (string-match ":" group))
3721            (server (and colon (substring group 0 colon)))
3722            (plus (and server (string-match "+" server))))
3723       (when server
3724         (if plus
3725             (setq foreign (substring server (+ 1 plus)
3726                                      (string-match "\\." server))
3727                   group (substring group (+ 1 colon)))
3728           (setq foreign server
3729                 group (substring group (+ 1 colon))))
3730         (setq foreign (concat foreign ":")))
3731       ;; Collapse group name leaving LEVELS uncollapsed elements
3732       (let* ((slist (split-string group "/"))
3733              (slen (length slist))
3734              (dlist (split-string group "\\."))
3735              (dlen (length dlist))
3736              glist
3737              glen
3738              gsep
3739              res)
3740         (if (> slen dlen)
3741             (setq glist slist
3742                   glen slen
3743                   gsep "/")
3744           (setq glist dlist
3745                 glen dlen
3746                 gsep "."))
3747         (setq levels (- glen levels))
3748         (dolist (g glist)
3749           (push (if (>= (decf levels) 0)
3750                     (if (zerop (length g))
3751                         ""
3752                       (substring g 0 1))
3753                   g)
3754                 res))
3755         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3756
3757 (defun gnus-narrow-to-body ()
3758   "Narrow to the body of an article."
3759   (narrow-to-region
3760    (progn
3761      (goto-char (point-min))
3762      (or (search-forward "\n\n" nil t)
3763          (point-max)))
3764    (point-max)))
3765
3766 \f
3767 ;;;
3768 ;;; Kill file handling.
3769 ;;;
3770
3771 (defun gnus-apply-kill-file ()
3772   "Apply a kill file to the current newsgroup.
3773 Returns the number of articles marked as read."
3774   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3775           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3776       (gnus-apply-kill-file-internal)
3777     0))
3778
3779 (defun gnus-kill-save-kill-buffer ()
3780   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3781     (when (get-file-buffer file)
3782       (save-excursion
3783         (set-buffer (get-file-buffer file))
3784         (when (buffer-modified-p)
3785           (save-buffer))
3786         (kill-buffer (current-buffer))))))
3787
3788 (defcustom gnus-kill-file-name "KILL"
3789   "Suffix of the kill files."
3790   :group 'gnus-score-kill
3791   :group 'gnus-score-files
3792   :type 'string)
3793
3794 (defun gnus-newsgroup-kill-file (newsgroup)
3795   "Return the name of a kill file name for NEWSGROUP.
3796 If NEWSGROUP is nil, return the global kill file name instead."
3797   (cond
3798    ;; The global KILL file is placed at top of the directory.
3799    ((or (null newsgroup)
3800         (string-equal newsgroup ""))
3801     (expand-file-name gnus-kill-file-name
3802                       gnus-kill-files-directory))
3803    ;; Append ".KILL" to newsgroup name.
3804    ((gnus-use-long-file-name 'not-kill)
3805     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3806                               "." gnus-kill-file-name)
3807                       gnus-kill-files-directory))
3808    ;; Place "KILL" under the hierarchical directory.
3809    (t
3810     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3811                               "/" gnus-kill-file-name)
3812                       gnus-kill-files-directory))))
3813
3814 ;;; Server things.
3815
3816 (defun gnus-member-of-valid (symbol group)
3817   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3818   (memq symbol (assoc
3819                 (symbol-name (car (gnus-find-method-for-group group)))
3820                 gnus-valid-select-methods)))
3821
3822 (defun gnus-method-option-p (method option)
3823   "Return non-nil if select METHOD has OPTION as a parameter."
3824   (when (stringp method)
3825     (setq method (gnus-server-to-method method)))
3826   (memq option (assoc (format "%s" (car method))
3827                       gnus-valid-select-methods)))
3828
3829 (defun gnus-similar-server-opened (method)
3830   (let ((opened gnus-opened-servers))
3831     (while (and method opened)
3832       (when (and (equal (cadr method) (cadaar opened))
3833                  (equal (car method) (caaar opened))
3834                  (not (equal method (caar opened))))
3835         (setq method nil))
3836       (pop opened))
3837     (not method)))
3838
3839 (defun gnus-server-extend-method (group method)
3840   ;; This function "extends" a virtual server.  If the server is
3841   ;; "hello", and the select method is ("hello" (my-var "something"))
3842   ;; in the group "alt.alt", this will result in a new virtual server
3843   ;; called "hello+alt.alt".
3844   (if (or (not (inline (gnus-similar-server-opened method)))
3845           (not (cddr method)))
3846       method
3847     `(,(car method) ,(concat (cadr method) "+" group)
3848       (,(intern (format "%s-address" (car method))) ,(cadr method))
3849       ,@(cddr method))))
3850
3851 (defun gnus-server-status (method)
3852   "Return the status of METHOD."
3853   (nth 1 (assoc method gnus-opened-servers)))
3854
3855 (defun gnus-group-name-to-method (group)
3856   "Guess a select method based on GROUP."
3857   (if (string-match ":" group)
3858       (let ((server (substring group 0 (match-beginning 0))))
3859         (if (string-match "\\+" server)
3860             (list (intern (substring server 0 (match-beginning 0)))
3861                   (substring server (match-end 0)))
3862           (list (intern server) "")))
3863     gnus-select-method))
3864
3865 (defun gnus-server-string (server)
3866   "Return a readable string that describes SERVER."
3867   (let* ((server (gnus-server-to-method server))
3868          (address (nth 1 server)))
3869     (if (and address
3870              (not (zerop (length address))))
3871         (format "%s using %s" address (car server))
3872       (format "%s" (car server)))))
3873
3874 (defun gnus-find-method-for-group (group &optional info)
3875   "Find the select method that GROUP uses."
3876   (or gnus-override-method
3877       (and (not group)
3878            gnus-select-method)
3879       (and (not (gnus-group-entry group)) ;; a new group
3880            (gnus-group-name-to-method group))
3881       (let ((info (or info (gnus-get-info group)))
3882             method)
3883         (if (or (not info)
3884                 (not (setq method (gnus-info-method info)))
3885                 (equal method "native"))
3886             gnus-select-method
3887           (setq method
3888                 (cond ((stringp method)
3889                        (inline (gnus-server-to-method method)))
3890                       ((stringp (cadr method))
3891                        (inline (gnus-server-extend-method group method)))
3892                       (t
3893                        method)))
3894           (cond ((equal (cadr method) "")
3895                  method)
3896                 ((null (cadr method))
3897                  (list (car method) ""))
3898                 (t
3899                  (gnus-server-add-address method)))))))
3900
3901 (defun gnus-methods-using (feature)
3902   "Find all methods that have FEATURE."
3903   (let ((valids gnus-valid-select-methods)
3904         outs)
3905     (while valids
3906       (when (memq feature (car valids))
3907         (push (car valids) outs))
3908       (setq valids (cdr valids)))
3909     outs))
3910
3911 (eval-when-compile
3912   (autoload 'message-y-or-n-p "message" nil nil 'macro))
3913
3914 (defun gnus-read-group (prompt &optional default)
3915   "Prompt the user for a group name.
3916 Disallow invalid group names."
3917   (let ((prefix "")
3918         group)
3919     (while (not group)
3920       (when (string-match
3921              gnus-invalid-group-regexp
3922              (setq group (read-string (concat prefix prompt)
3923                                       (cons (or default "") 0)
3924                                       'gnus-group-history)))
3925         (let ((match (match-string 0 group)))
3926           ;; Might be okay (e.g. for nnimap), so ask the user:
3927           (unless (and (not (string-match "^$\\|:" match))
3928                        (message-y-or-n-p
3929                         "Proceed and create group anyway? " t
3930 "The group name \"" group "\" contains a forbidden character: \"" match "\".
3931
3932 Usually, it's dangerous to create a group with this name, because it's not
3933 supported by all back ends and servers.  On IMAP servers it should work,
3934 though.  If you are really sure, you can proceed anyway and create the group.
3935
3936 You may customize the variable `gnus-invalid-group-regexp', which currently is
3937 set to \"" gnus-invalid-group-regexp
3938 "\", if you want to get rid of this query permanently."))
3939             (setq prefix (format "Invalid group name: \"%s\".  " group)
3940                   group nil)))))
3941     group))
3942
3943 (defun gnus-read-method (prompt)
3944   "Prompt the user for a method.
3945 Allow completion over sensible values."
3946   (let* ((open-servers
3947           (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3948                   gnus-opened-servers))
3949          (valid-methods
3950           (let (methods)
3951             (dolist (method gnus-valid-select-methods)
3952               (if (or (memq 'prompt-address method)
3953                       (not (assoc (format "%s:" (car method)) open-servers)))
3954                   (push method methods)))
3955             methods))
3956          (servers
3957           (append valid-methods
3958                   open-servers
3959                   gnus-predefined-server-alist
3960                   gnus-server-alist))
3961          (method
3962           (completing-read
3963            prompt servers
3964            nil t nil 'gnus-method-history)))
3965     (cond
3966      ((equal method "")
3967       (setq method gnus-select-method))
3968      ((assoc method gnus-valid-select-methods)
3969       (let ((address (if (memq 'prompt-address
3970                                (assoc method gnus-valid-select-methods))
3971                          (read-string "Address: ")
3972                        "")))
3973         (or (cadr (assoc (format "%s:%s" method address) open-servers))
3974             (list (intern method) address))))
3975      ((assoc method servers)
3976       method)
3977      (t
3978       (list (intern method) "")))))
3979
3980 ;;; Agent functions
3981
3982 (defun gnus-agent-method-p (method)
3983   "Say whether METHOD is covered by the agent."
3984   (or (eq (car gnus-agent-method-p-cache) method)
3985       (setq gnus-agent-method-p-cache 
3986             (cons method
3987                   (member (if (stringp method) 
3988                               method 
3989                             (gnus-method-to-server method)) gnus-agent-covered-methods))))
3990   (cdr gnus-agent-method-p-cache))
3991
3992 (defun gnus-online (method)
3993   (not
3994    (if gnus-plugged
3995        (eq (cadr (assoc method gnus-opened-servers)) 'offline)
3996      (gnus-agent-method-p method))))
3997
3998 ;;; User-level commands.
3999
4000 ;;;###autoload
4001 (defun gnus-slave-no-server (&optional arg)
4002   "Read network news as a slave, without connecting to the local server."
4003   (interactive "P")
4004   (gnus-no-server arg t))
4005
4006 ;;;###autoload
4007 (defun gnus-no-server (&optional arg slave)
4008   "Read network news.
4009 If ARG is a positive number, Gnus will use that as the startup
4010 level. If ARG is nil, Gnus will be started at level 2.  If ARG is
4011 non-nil and not a positive number, Gnus will prompt the user for the
4012 name of an NNTP server to use.
4013 As opposed to `gnus', this command will not connect to the local
4014 server."
4015   (interactive "P")
4016   (gnus-no-server-1 arg slave))
4017
4018 ;;;###autoload
4019 (defun gnus-slave (&optional arg)
4020   "Read news as a slave."
4021   (interactive "P")
4022   (gnus arg nil 'slave))
4023
4024 ;;;###autoload
4025 (defun gnus-other-frame (&optional arg display)
4026   "Pop up a frame to read news.
4027 This will call one of the Gnus commands which is specified by the user
4028 option `gnus-other-frame-function' (default `gnus') with the argument
4029 ARG if Gnus is not running, otherwise just pop up a Gnus frame.  The
4030 optional second argument DISPLAY should be a standard display string
4031 such as \"unix:0\" to specify where to pop up a frame.  If DISPLAY is
4032 omitted or the function `make-frame-on-display' is not available, the
4033 current display is used."
4034   (interactive "P")
4035   (if (fboundp 'make-frame-on-display)
4036       (unless display
4037         (setq display (gnus-frame-or-window-display-name (selected-frame))))
4038     (setq display nil))
4039   (let ((alive (gnus-alive-p)))
4040     (unless (and alive
4041                  (catch 'found
4042                    (walk-windows
4043                     (lambda (window)
4044                       (when (and (or (not display)
4045                                      (equal display
4046                                             (gnus-frame-or-window-display-name
4047                                              window)))
4048                                  (with-current-buffer (window-buffer window)
4049                                    (string-match "\\`gnus-"
4050                                                  (symbol-name major-mode))))
4051                         (gnus-select-frame-set-input-focus
4052                          (setq gnus-other-frame-object (window-frame window)))
4053                         (select-window window)
4054                         (throw 'found t)))
4055                     'ignore t)))
4056       (gnus-select-frame-set-input-focus
4057        (setq gnus-other-frame-object
4058              (if display
4059                  (make-frame-on-display display gnus-other-frame-parameters)
4060                (make-frame gnus-other-frame-parameters))))
4061       (if alive
4062           (switch-to-buffer gnus-group-buffer)
4063         (funcall gnus-other-frame-function arg)
4064         (add-hook 'gnus-exit-gnus-hook
4065                   '(lambda nil
4066                      (when (and (frame-live-p gnus-other-frame-object)
4067                                 (cdr (frame-list)))
4068                        (delete-frame gnus-other-frame-object))
4069                      (setq gnus-other-frame-object nil)))))))
4070
4071 ;;(setq thing ?                         ; this is a comment
4072 ;;      more 'yes)
4073
4074 ;;;###autoload
4075 (defun gnus (&optional arg dont-connect slave)
4076   "Read network news.
4077 If ARG is non-nil and a positive number, Gnus will use that as the
4078 startup level.  If ARG is non-nil and not a positive number, Gnus will
4079 prompt the user for the name of an NNTP server to use."
4080   (interactive "P")
4081   (unless (byte-code-function-p (symbol-function 'gnus))
4082     (message "You should byte-compile Gnus")
4083     (sit-for 2))
4084   (gnus-1 arg dont-connect slave))
4085
4086 ;; Allow redefinition of Gnus functions.
4087
4088 (gnus-ems-redefine)
4089
4090 (provide 'gnus)
4091
4092 ;;; gnus.el ends here