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