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