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