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