* gnus-sum.el (gnus-summary-dummy-line-format):
[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.06"
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 "DejaNews" (nnweb "refer" (nnweb-type dejanews)))
1199                  gnus-select-method
1200                  (repeat :menu-tag "Try multiple"
1201                          :tag "Multiple"
1202                          :value (current (nnweb "refer" (nnweb-type dejanews)))
1203                          (choice :tag "Method"
1204                                  (const current)
1205                                  (const :tag "DejaNews"
1206                                         (nnweb "refer" (nnweb-type dejanews)))
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 'integer)
1273
1274 (defcustom gnus-use-long-file-name (not (memq system-type '(usg-unix-v xenix)))
1275   "*Non-nil means that the default name of a file to save articles in is the group name.
1276 If it's nil, the directory form of the group name is used instead.
1277
1278 If this variable is a list, and the list contains the element
1279 `not-score', long file names will not be used for score files; if it
1280 contains the element `not-save', long file names will not be used for
1281 saving; and if it contains the element `not-kill', long file names
1282 will not be used for kill files.
1283
1284 Note that the default for this variable varies according to what system
1285 type you're using.  On `usg-unix-v' and `xenix' this variable defaults
1286 to nil while on all other systems it defaults to t."
1287   :group 'gnus-start
1288   :type 'boolean)
1289
1290 (defcustom gnus-kill-files-directory gnus-directory
1291   "*Name of the directory where kill files will be stored (default \"~/News\")."
1292   :group 'gnus-score-files
1293   :group 'gnus-score-kill
1294   :type 'directory)
1295
1296 (defcustom gnus-save-score nil
1297   "*If non-nil, save group scoring info."
1298   :group 'gnus-score-various
1299   :group 'gnus-start
1300   :type 'boolean)
1301
1302 (defcustom gnus-use-undo t
1303   "*If non-nil, allow undoing in Gnus group mode buffers."
1304   :group 'gnus-meta
1305   :type 'boolean)
1306
1307 (defcustom gnus-use-adaptive-scoring nil
1308   "*If non-nil, use some adaptive scoring scheme.
1309 If a list, then the values `word' and `line' are meaningful.  The
1310 former will perform adaption on individual words in the subject
1311 header while `line' will perform adaption on several headers."
1312   :group 'gnus-meta
1313   :group 'gnus-score-adapt
1314   :type '(set (const word) (const line)))
1315
1316 (defcustom gnus-use-cache 'passive
1317   "*If nil, Gnus will ignore the article cache.
1318 If `passive', it will allow entering (and reading) articles
1319 explicitly entered into the cache.  If anything else, use the
1320 cache to the full extent of the law."
1321   :group 'gnus-meta
1322   :group 'gnus-cache
1323   :type '(choice (const :tag "off" nil)
1324                  (const :tag "passive" passive)
1325                  (const :tag "active" t)))
1326
1327 (defcustom gnus-use-trees nil
1328   "*If non-nil, display a thread tree buffer."
1329   :group 'gnus-meta
1330   :type 'boolean)
1331
1332 (defcustom gnus-use-grouplens nil
1333   "*If non-nil, use GroupLens ratings."
1334   :group 'gnus-meta
1335   :type 'boolean)
1336
1337 (defcustom gnus-keep-backlog nil
1338   "*If non-nil, Gnus will keep read articles for later re-retrieval.
1339 If it is a number N, then Gnus will only keep the last N articles
1340 read.  If it is neither nil nor a number, Gnus will keep all read
1341 articles.  This is not a good idea."
1342   :group 'gnus-meta
1343   :type '(choice (const :tag "off" nil)
1344                  integer
1345                  (sexp :format "all"
1346                        :value t)))
1347
1348 (defcustom gnus-use-nocem nil
1349   "*If non-nil, Gnus will read NoCeM cancel messages."
1350   :group 'gnus-meta
1351   :type 'boolean)
1352
1353 (defcustom gnus-suppress-duplicates nil
1354   "*If non-nil, Gnus will mark duplicate copies of the same article as read."
1355   :group 'gnus-meta
1356   :type 'boolean)
1357
1358 (defcustom gnus-use-scoring t
1359   "*If non-nil, enable scoring."
1360   :group 'gnus-meta
1361   :type 'boolean)
1362
1363 (defcustom gnus-summary-prepare-exit-hook
1364   '(gnus-summary-expire-articles)
1365   "*A hook called when preparing to exit from the summary buffer.
1366 It calls `gnus-summary-expire-articles' by default."
1367   :group 'gnus-summary-exit
1368   :type 'hook)
1369
1370 (defcustom gnus-novice-user t
1371   "*Non-nil means that you are a usenet novice.
1372 If non-nil, verbose messages may be displayed and confirmations may be
1373 required."
1374   :group 'gnus-meta
1375   :type 'boolean)
1376
1377 (defcustom gnus-expert-user nil
1378   "*Non-nil means that you will never be asked for confirmation about anything.
1379 That doesn't mean *anything* anything; particularly destructive
1380 commands will still require prompting."
1381   :group 'gnus-meta
1382   :type 'boolean)
1383
1384 (defcustom gnus-interactive-catchup t
1385   "*If non-nil, require your confirmation when catching up a group."
1386   :group 'gnus-group-select
1387   :type 'boolean)
1388
1389 (defcustom gnus-interactive-exit t
1390   "*If non-nil, require your confirmation when exiting Gnus."
1391   :group 'gnus-exit
1392   :type 'boolean)
1393
1394 (defcustom gnus-extract-address-components 'gnus-extract-address-components
1395   "*Function for extracting address components from a From header.
1396 Two pre-defined function exist: `gnus-extract-address-components',
1397 which is the default, quite fast, and too simplistic solution, and
1398 `mail-extract-address-components', which works much better, but is
1399 slower."
1400   :group 'gnus-summary-format
1401   :type '(radio (function-item gnus-extract-address-components)
1402                 (function-item mail-extract-address-components)
1403                 (function :tag "Other")))
1404
1405 (defcustom gnus-carpal nil
1406   "*If non-nil, display clickable icons."
1407   :group 'gnus-meta
1408   :type 'boolean)
1409
1410 (defcustom gnus-shell-command-separator ";"
1411   "String used to separate to shell commands."
1412   :group 'gnus-files
1413   :type 'string)
1414
1415 (defcustom gnus-valid-select-methods
1416   '(("nntp" post address prompt-address physical-address)
1417     ("nnspool" post address)
1418     ("nnvirtual" post-mail virtual prompt-address)
1419     ("nnmbox" mail respool address)
1420     ("nnml" post-mail respool address)
1421     ("nnmh" mail respool address)
1422     ("nndir" post-mail prompt-address physical-address)
1423     ("nneething" none address prompt-address physical-address)
1424     ("nndoc" none address prompt-address)
1425     ("nnbabyl" mail address respool)
1426     ("nnkiboze" post virtual)
1427     ("nnsoup" post-mail address)
1428     ("nndraft" post-mail)
1429     ("nnfolder" mail respool address)
1430     ("nngateway" post-mail address prompt-address physical-address)
1431     ("nnweb" none)
1432     ("nngoogle" post)
1433     ("nnslashdot" post)
1434     ("nnultimate" none)
1435     ("nnrss" none)
1436     ("nnwfm" none)
1437     ("nnwarchive" none)
1438     ("nnlistserv" none)
1439     ("nnagent" post-mail)
1440     ("nnimap" post-mail address prompt-address physical-address)
1441     ("nnmaildir" mail respool address)
1442     ("nnnil" none))
1443   "*An alist of valid select methods.
1444 The first element of each list lists should be a string with the name
1445 of the select method.  The other elements may be the category of
1446 this method (i. e., `post', `mail', `none' or whatever) or other
1447 properties that this method has (like being respoolable).
1448 If you implement a new select method, all you should have to change is
1449 this variable.  I think."
1450   :group 'gnus-server
1451   :type '(repeat (group (string :tag "Name")
1452                         (radio-button-choice (const :format "%v " post)
1453                                              (const :format "%v " mail)
1454                                              (const :format "%v " none)
1455                                              (const post-mail))
1456                         (checklist :inline t
1457                                    (const :format "%v " address)
1458                                    (const :format "%v " prompt-address)
1459                                    (const :format "%v " physical-address)
1460                                    (const :format "%v " virtual)
1461                                    (const respool)))))
1462
1463 (defun gnus-redefine-select-method-widget ()
1464   "Recomputes the select-method widget based on the value of
1465 `gnus-valid-select-methods'."
1466   (define-widget 'gnus-select-method 'list
1467     "Widget for entering a select method."
1468     :value '(nntp "")
1469     :tag "Select Method"
1470     :args `((choice :tag "Method"
1471                     ,@(mapcar (lambda (entry)
1472                                 (list 'const :format "%v\n"
1473                                       (intern (car entry))))
1474                               gnus-valid-select-methods)
1475                     (symbol :tag "other"))
1476             (string :tag "Address")
1477             (repeat :tag "Options"
1478                     :inline t
1479                     (list :format "%v"
1480                           variable
1481                           (sexp :tag "Value"))))))
1482
1483 (gnus-redefine-select-method-widget)
1484
1485 (defcustom gnus-updated-mode-lines '(group article summary tree)
1486   "List of buffers that should update their mode lines.
1487 The list may contain the symbols `group', `article', `tree' and
1488 `summary'.  If the corresponding symbol is present, Gnus will keep
1489 that mode line updated with information that may be pertinent.
1490 If this variable is nil, screen refresh may be quicker."
1491   :group 'gnus-various
1492   :type '(set (const group)
1493               (const article)
1494               (const summary)
1495               (const tree)))
1496
1497 ;; Added by Keinonen Kari <kk85613@cs.tut.fi>.
1498 (defcustom gnus-mode-non-string-length nil
1499   "*Max length of mode-line non-string contents.
1500 If this is nil, Gnus will take space as is needed, leaving the rest
1501 of the modeline intact.  Note that the default of nil is unlikely
1502 to be desirable; see the manual for further details."
1503   :group 'gnus-various
1504   :type '(choice (const nil)
1505                  integer))
1506
1507 ;; There should be special validation for this.
1508 (define-widget 'gnus-email-address 'string
1509   "An email address")
1510
1511 (gnus-define-group-parameter
1512  to-address
1513  :function-document
1514  "Return GROUP's to-address."
1515  :variable-document
1516  "*Alist of group regexps and correspondent to-addresses."
1517  :parameter-type '(gnus-email-address :tag "To Address")
1518  :parameter-document "\
1519 This will be used when doing followups and posts.
1520
1521 This is primarily useful in mail groups that represent closed
1522 mailing lists--mailing lists where it's expected that everybody that
1523 writes to the mailing list is subscribed to it.  Since using this
1524 parameter ensures that the mail only goes to the mailing list itself,
1525 it means that members won't receive two copies of your followups.
1526
1527 Using `to-address' will actually work whether the group is foreign or
1528 not.  Let's say there's a group on the server that is called
1529 `fa.4ad-l'.  This is a real newsgroup, but the server has gotten the
1530 articles from a mail-to-news gateway.  Posting directly to this group
1531 is therefore impossible--you have to send mail to the mailing list
1532 address instead.
1533
1534 The gnus-group-split mail splitting mechanism will behave as if this
1535 address was listed in gnus-group-split Addresses (see below).")
1536
1537 (gnus-define-group-parameter
1538  to-list
1539  :function-document
1540  "Return GROUP's to-list."
1541  :variable-document
1542  "*Alist of group regexps and correspondent to-lists."
1543  :parameter-type '(gnus-email-address :tag "To List")
1544  :parameter-document "\
1545 This address will be used when doing a `a' in the group.
1546
1547 It is totally ignored when doing a followup--except that if it is
1548 present in a news group, you'll get mail group semantics when doing
1549 `f'.
1550
1551 The gnus-group-split mail splitting mechanism will behave as if this
1552 address was listed in gnus-group-split Addresses (see below).")
1553
1554 (gnus-define-group-parameter
1555  auto-expire
1556  :type bool
1557  :function gnus-group-auto-expirable-p
1558  :function-document
1559  "Check whether GROUP is auto-expirable or not."
1560  :variable gnus-auto-expirable-newsgroups
1561  :variable-default nil
1562  :variable-document
1563  "*Groups in which to automatically mark read articles as expirable.
1564 If non-nil, this should be a regexp that should match all groups in
1565 which to perform auto-expiry.  This only makes sense for mail groups."
1566  :variable-group nnmail-expire
1567  :variable-type '(choice (const nil)
1568                          regexp)
1569  :parameter-type '(const :tag "Automatic Expire" t)
1570  :parameter-document
1571  "All articles that are read will be marked as expirable.")
1572
1573 (gnus-define-group-parameter
1574  total-expire
1575  :type bool
1576  :function gnus-group-total-expirable-p
1577  :function-document
1578  "Check whether GROUP is total-expirable or not."
1579  :variable gnus-total-expirable-newsgroups
1580  :variable-default nil
1581  :variable-document
1582  "*Groups in which to perform expiry of all read articles.
1583 Use with extreme caution.  All groups that match this regexp will be
1584 expiring - which means that all read articles will be deleted after
1585 \(say) one week.         (This only goes for mail groups and the like, of
1586 course.)"
1587  :variable-group nnmail-expire
1588  :variable-type '(choice (const nil)
1589                          regexp)
1590  :parameter-type '(const :tag "Total Expire" t)
1591  :parameter-document
1592  "All read articles will be put through the expiry process
1593
1594 This happens even if they are not marked as expirable.
1595 Use with caution.")
1596
1597 (gnus-define-group-parameter
1598  charset
1599  :function-document
1600  "Return the default charset of GROUP."
1601  :variable gnus-group-charset-alist
1602  :variable-default
1603  '(("\\(^\\|:\\)hk\\>\\|\\(^\\|:\\)tw\\>\\|\\<big5\\>" cn-big5)
1604    ("\\(^\\|:\\)cn\\>\\|\\<chinese\\>" cn-gb-2312)
1605    ("\\(^\\|:\\)fj\\>\\|\\(^\\|:\\)japan\\>" iso-2022-jp-2)
1606    ("\\(^\\|:\\)tnn\\>\\|\\(^\\|:\\)pin\\>\\|\\(^\\|:\\)sci.lang.japan" iso-2022-7bit)
1607    ("\\(^\\|:\\)relcom\\>" koi8-r)
1608    ("\\(^\\|:\\)fido7\\>" koi8-r)
1609    ("\\(^\\|:\\)\\(cz\\|hun\\|pl\\|sk\\|hr\\)\\>" iso-8859-2)
1610    ("\\(^\\|:\\)israel\\>" iso-8859-1)
1611    ("\\(^\\|:\\)han\\>" euc-kr)
1612    ("\\(^\\|:\\)alt.chinese.text.big5\\>" chinese-big5)
1613    ("\\(^\\|:\\)soc.culture.vietnamese\\>" vietnamese-viqr)
1614    ("\\(^\\|:\\)\\(comp\\|rec\\|alt\\|sci\\|soc\\|news\\|gnu\\|bofh\\)\\>" iso-8859-1))
1615  :variable-document
1616  "Alist of regexps (to match group names) and default charsets to be used when reading."
1617  :variable-group gnus-charset
1618  :variable-type '(repeat (list (regexp :tag "Group")
1619                                (symbol :tag "Charset")))
1620  :parameter-type '(symbol :tag "Charset")
1621  :parameter-document "\
1622 The default charset to use in the group.")
1623
1624 (gnus-define-group-parameter
1625  post-method
1626  :type list
1627  :function-document
1628  "Return a posting method for GROUP."
1629  :variable gnus-post-method-alist
1630  :variable-document
1631  "Alist of regexps (to match group names) and method to be used when
1632 posting an article."
1633  :variable-group gnus-group-foreign
1634  :parameter-type
1635  '(choice :tag "Posting Method"
1636           (const :tag "Use native server" native)
1637           (const :tag "Use current server" current)
1638           (list :convert-widget
1639                 (lambda (widget)
1640                   (list 'sexp :tag "Methods"
1641                         :value gnus-select-method))))
1642  :parameter-document
1643  "Posting method for this group.")
1644
1645 (gnus-define-group-parameter
1646  large-newsgroup-initial
1647  :type integer
1648  :function-document
1649  "Return GROUP's initial input of the number of articles."
1650  :variable-document
1651  "*Alist of group regexps and its initial input of the number of articles."
1652  :parameter-type '(choice :tag "Initial Input for Large Newsgroup"
1653                           (const :tag "All" nil)
1654                           (integer))
1655  :parameter-document "\
1656
1657 This number will be prompted as the initial value of the number of
1658 articles to list when the group is a large newsgroup (see
1659 `gnus-large-newsgroup').  If it is `nil', the default value is the
1660 total number of articles in the group.")
1661
1662 (defcustom gnus-group-uncollapsed-levels 1
1663   "Number of group name elements to leave alone when making a short group name."
1664   :group 'gnus-group-visual
1665   :type 'integer)
1666
1667 (defcustom gnus-group-use-permanent-levels nil
1668   "*If non-nil, once you set a level, Gnus will use this level."
1669   :group 'gnus-group-levels
1670   :type 'boolean)
1671
1672 ;; Hooks.
1673
1674 (defcustom gnus-load-hook nil
1675   "A hook run while Gnus is loaded."
1676   :group 'gnus-start
1677   :type 'hook)
1678
1679 (defcustom gnus-apply-kill-hook '(gnus-apply-kill-file)
1680   "A hook called to apply kill files to a group.
1681 This hook is intended to apply a kill file to the selected newsgroup.
1682 The function `gnus-apply-kill-file' is called by default.
1683
1684 Since a general kill file is too heavy to use only for a few
1685 newsgroups, I recommend you to use a lighter hook function.  For
1686 example, if you'd like to apply a kill file to articles which contains
1687 a string `rmgroup' in subject in newsgroup `control', you can use the
1688 following hook:
1689
1690  (setq gnus-apply-kill-hook
1691       (list
1692         (lambda ()
1693           (cond ((string-match \"control\" gnus-newsgroup-name)
1694                  (gnus-kill \"Subject\" \"rmgroup\")
1695                  (gnus-expunge \"X\"))))))"
1696   :group 'gnus-score-kill
1697   :options '(gnus-apply-kill-file)
1698   :type 'hook)
1699
1700 (defcustom gnus-group-change-level-function nil
1701   "Function run when a group level is changed.
1702 It is called with three parameters -- GROUP, LEVEL and OLDLEVEL."
1703   :group 'gnus-group-levels
1704   :type 'function)
1705
1706 ;;; Face thingies.
1707
1708 (defcustom gnus-visual
1709   '(summary-highlight group-highlight article-highlight
1710                       mouse-face
1711                       summary-menu group-menu article-menu
1712                       tree-highlight menu highlight
1713                       browse-menu server-menu
1714                       page-marker tree-menu binary-menu pick-menu
1715                       grouplens-menu)
1716   "*Enable visual features.
1717 If `visual' is disabled, there will be no menus and few faces.  Most of
1718 the visual customization options below will be ignored.  Gnus will use
1719 less space and be faster as a result.
1720
1721 This variable can also be a list of visual elements to switch on.  For
1722 instance, to switch off all visual things except menus, you can say:
1723
1724    (setq gnus-visual '(menu))
1725
1726 Valid elements include `summary-highlight', `group-highlight',
1727 `article-highlight', `mouse-face', `summary-menu', `group-menu',
1728 `article-menu', `tree-highlight', `menu', `highlight', `browse-menu',
1729 `server-menu', `page-marker', `tree-menu', `binary-menu', `pick-menu',
1730 and `grouplens-menu'."
1731   :group 'gnus-meta
1732   :group 'gnus-visual
1733   :type '(set (const summary-highlight)
1734               (const group-highlight)
1735               (const article-highlight)
1736               (const mouse-face)
1737               (const summary-menu)
1738               (const group-menu)
1739               (const article-menu)
1740               (const tree-highlight)
1741               (const menu)
1742               (const highlight)
1743               (const browse-menu)
1744               (const server-menu)
1745               (const page-marker)
1746               (const tree-menu)
1747               (const binary-menu)
1748               (const pick-menu)
1749               (const grouplens-menu)))
1750
1751 ;; Byte-compiler warning.
1752 (defvar gnus-visual)
1753 ;; Find out whether the gnus-visual TYPE is wanted.
1754 (defun gnus-visual-p (&optional type class)
1755   (and gnus-visual                      ; Has to be non-nil, at least.
1756        (if (not type)                   ; We don't care about type.
1757            gnus-visual
1758          (if (listp gnus-visual)        ; It's a list, so we check it.
1759              (or (memq type gnus-visual)
1760                  (memq class gnus-visual))
1761            t))))
1762
1763 (defcustom gnus-mouse-face
1764   (condition-case ()
1765       (if (gnus-visual-p 'mouse-face 'highlight)
1766           (if (boundp 'gnus-mouse-face)
1767               (or gnus-mouse-face 'highlight)
1768             'highlight)
1769         'default)
1770     (error 'highlight))
1771   "*Face used for group or summary buffer mouse highlighting.
1772 The line beneath the mouse pointer will be highlighted with this
1773 face."
1774   :group 'gnus-visual
1775   :type 'face)
1776
1777 (defcustom gnus-article-save-directory gnus-directory
1778   "*Name of the directory articles will be saved in (default \"~/News\")."
1779   :group 'gnus-article-saving
1780   :type 'directory)
1781
1782 (defvar gnus-plugged t
1783   "Whether Gnus is plugged or not.")
1784
1785 (defcustom gnus-agent-cache t
1786   "Whether Gnus use agent cache."
1787   :version "21.3"
1788   :group 'gnus-agent
1789   :type 'boolean)
1790
1791 (defcustom gnus-default-charset (mm-guess-mime-charset)
1792   "Default charset assumed to be used when viewing non-ASCII characters.
1793 This variable is overridden on a group-to-group basis by the
1794 gnus-group-charset-alist variable and is only used on groups not
1795 covered by that variable."
1796   :type 'symbol
1797   :group 'gnus-charset)
1798
1799 (defcustom gnus-agent nil
1800   "Whether we want to use the Gnus agent or not.
1801 Putting (gnus-agentize) in ~/.gnus is obsolete by (setq gnus-agent t)."
1802   :version "21.3"
1803   :group 'gnus-agent
1804   :type 'boolean)
1805
1806 \f
1807 ;;; Internal variables
1808
1809 (defvar gnus-agent-gcc-header "X-Gnus-Agent-Gcc")
1810 (defvar gnus-agent-meta-information-header "X-Gnus-Agent-Meta-Information")
1811 (defvar gnus-draft-meta-information-header "X-Draft-From")
1812 (defvar gnus-group-get-parameter-function 'gnus-group-get-parameter)
1813 (defvar gnus-original-article-buffer " *Original Article*")
1814 (defvar gnus-newsgroup-name nil)
1815 (defvar gnus-ephemeral-servers nil)
1816 (defvar gnus-server-method-cache nil)
1817
1818 (defvar gnus-agent-fetching nil
1819   "Whether Gnus agent is in fetching mode.")
1820
1821 (defvar gnus-agent-covered-methods nil)
1822
1823 (defvar gnus-command-method nil
1824   "Dynamically bound variable that says what the current back end is.")
1825
1826 (defvar gnus-current-select-method nil
1827   "The current method for selecting a newsgroup.")
1828
1829 (defvar gnus-tree-buffer "*Tree*"
1830   "Buffer where Gnus thread trees are displayed.")
1831
1832 ;; Dummy variable.
1833 (defvar gnus-use-generic-from nil)
1834
1835 ;; Variable holding the user answers to all method prompts.
1836 (defvar gnus-method-history nil)
1837
1838 ;; Variable holding the user answers to all mail method prompts.
1839 (defvar gnus-mail-method-history nil)
1840
1841 ;; Variable holding the user answers to all group prompts.
1842 (defvar gnus-group-history nil)
1843
1844 (defvar gnus-server-alist nil
1845   "List of available servers.")
1846
1847 (defcustom gnus-cache-directory
1848   (nnheader-concat gnus-directory "cache/")
1849   "*The directory where cached articles will be stored."
1850   :group 'gnus-cache
1851   :type 'directory)
1852
1853 (defvar gnus-predefined-server-alist
1854   `(("cache"
1855      nnspool "cache"
1856      (nnspool-spool-directory ,gnus-cache-directory)
1857      (nnspool-nov-directory ,gnus-cache-directory)
1858      (nnspool-active-file
1859       ,(nnheader-concat gnus-cache-directory "active"))))
1860   "List of predefined (convenience) servers.")
1861
1862 (defvar gnus-topic-indentation "") ;; Obsolete variable.
1863
1864 (defconst gnus-article-mark-lists
1865   '((marked . tick) (replied . reply)
1866     (expirable . expire) (killed . killed)
1867     (bookmarks . bookmark) (dormant . dormant)
1868     (scored . score) (saved . save)
1869     (cached . cache) (downloadable . download)
1870     (unsendable . unsend) (forwarded . forward)
1871     (recent . recent) (seen . seen)))
1872
1873 (defconst gnus-article-special-mark-lists
1874   '((seen range)
1875     (killed range)
1876     (bookmark tuple)
1877     (score tuple)))
1878
1879 ;; Propagate flags to server, with the following exceptions:
1880 ;; `seen' is private to each gnus installation
1881 ;; `cache' is a internal gnus flag for each gnus installation
1882 ;; `download' is a agent flag private to each gnus installation
1883 ;; `unsend' are for nndraft groups only
1884 ;; `score' is not a proper mark
1885 ;; `bookmark': don't propagated it, or fix the bug in update-mark.
1886 (defconst gnus-article-unpropagated-mark-lists
1887   '(seen cache download unsend score bookmark)
1888   "Marks that shouldn't be propagated to back ends.
1889 Typical marks are those that make no sense in a standalone back end,
1890 such as a mark that says whether an article is stored in the cache
1891 \(which doesn't make sense in a standalone back end).")
1892
1893 (defvar gnus-headers-retrieved-by nil)
1894 (defvar gnus-article-reply nil)
1895 (defvar gnus-override-method nil)
1896 (defvar gnus-article-check-size nil)
1897 (defvar gnus-opened-servers nil)
1898
1899 (defvar gnus-current-kill-article nil)
1900
1901 (defvar gnus-have-read-active-file nil)
1902
1903 (defconst gnus-maintainer
1904   "bugs@gnus.org (The Gnus Bugfixing Girls + Boys)"
1905   "The mail address of the Gnus maintainers.")
1906
1907 (defvar gnus-info-nodes
1908   '((gnus-group-mode "(gnus)Group Buffer")
1909     (gnus-summary-mode "(gnus)Summary Buffer")
1910     (gnus-article-mode "(gnus)Article Buffer")
1911     (gnus-server-mode "(gnus)Server Buffer")
1912     (gnus-browse-mode "(gnus)Browse Foreign Server")
1913     (gnus-tree-mode "(gnus)Tree Display"))
1914   "Alist of major modes and related Info nodes.")
1915
1916 (defvar gnus-group-buffer "*Group*")
1917 (defvar gnus-summary-buffer "*Summary*")
1918 (defvar gnus-article-buffer "*Article*")
1919 (defvar gnus-server-buffer "*Server*")
1920
1921 (defvar gnus-slave nil
1922   "Whether this Gnus is a slave or not.")
1923
1924 (defvar gnus-batch-mode nil
1925   "Whether this Gnus is running in batch mode or not.")
1926
1927 (defvar gnus-variable-list
1928   '(gnus-newsrc-options gnus-newsrc-options-n
1929                         gnus-newsrc-last-checked-date
1930                         gnus-newsrc-alist gnus-server-alist
1931                         gnus-killed-list gnus-zombie-list
1932                         gnus-topic-topology gnus-topic-alist
1933                         gnus-format-specs)
1934   "Gnus variables saved in the quick startup file.")
1935
1936 (defvar gnus-newsrc-alist nil
1937   "Assoc list of read articles.
1938 gnus-newsrc-hashtb should be kept so that both hold the same information.")
1939
1940 (defvar gnus-newsrc-hashtb nil
1941   "Hashtable of gnus-newsrc-alist.")
1942
1943 (defvar gnus-killed-list nil
1944   "List of killed newsgroups.")
1945
1946 (defvar gnus-killed-hashtb nil
1947   "Hash table equivalent of gnus-killed-list.")
1948
1949 (defvar gnus-zombie-list nil
1950   "List of almost dead newsgroups.")
1951
1952 (defvar gnus-description-hashtb nil
1953   "Descriptions of newsgroups.")
1954
1955 (defvar gnus-list-of-killed-groups nil
1956   "List of newsgroups that have recently been killed by the user.")
1957
1958 (defvar gnus-active-hashtb nil
1959   "Hashtable of active articles.")
1960
1961 (defvar gnus-moderated-hashtb nil
1962   "Hashtable of moderated newsgroups.")
1963
1964 ;; Save window configuration.
1965 (defvar gnus-prev-winconf nil)
1966
1967 (defvar gnus-reffed-article-number nil)
1968
1969 ;;; Let the byte-compiler know that we know about this variable.
1970 (defvar rmail-default-rmail-file)
1971
1972 (defvar gnus-dead-summary nil)
1973
1974 (defvar gnus-invalid-group-regexp "[: `'\"/]\\|^$"
1975   "Regexp matching invalid groups.")
1976
1977 ;;; End of variables.
1978
1979 ;; Define some autoload functions Gnus might use.
1980 (eval-and-compile
1981
1982   ;; This little mapcar goes through the list below and marks the
1983   ;; symbols in question as autoloaded functions.
1984   (mapcar
1985    (lambda (package)
1986      (let ((interactive (nth 1 (memq ':interactive package))))
1987        (mapcar
1988         (lambda (function)
1989           (let (keymap)
1990             (when (consp function)
1991               (setq keymap (car (memq 'keymap function)))
1992               (setq function (car function)))
1993             (unless (fboundp function)
1994               (autoload function (car package) nil interactive keymap))))
1995         (if (eq (nth 1 package) ':interactive)
1996             (nthcdr 3 package)
1997           (cdr package)))))
1998    '(("info" :interactive t Info-goto-node)
1999      ("pp" pp-to-string)
2000      ("qp" quoted-printable-decode-region quoted-printable-decode-string)
2001      ("ps-print" ps-print-preprint)
2002      ("message" :interactive t
2003       message-send-and-exit message-yank-original)
2004      ("babel" babel-as-string)
2005      ("nnmail" nnmail-split-fancy nnmail-article-group)
2006      ("nnvirtual" nnvirtual-catchup-group nnvirtual-convert-headers)
2007      ("rmailout" rmail-output rmail-output-to-rmail-file)
2008      ("rmail" rmail-insert-rmail-file-header rmail-count-new-messages
2009       rmail-show-message rmail-summary-exists
2010       rmail-select-summary rmail-update-summary)
2011      ("gnus-audio" :interactive t gnus-audio-play)
2012      ("gnus-xmas" gnus-xmas-splash)
2013      ("gnus-soup" :interactive t
2014       gnus-group-brew-soup gnus-brew-soup gnus-soup-add-article
2015       gnus-soup-send-replies gnus-soup-save-areas gnus-soup-pack-packet)
2016      ("nnsoup" nnsoup-pack-replies)
2017      ("score-mode" :interactive t gnus-score-mode)
2018      ("gnus-mh" gnus-summary-save-article-folder
2019       gnus-Folder-save-name gnus-folder-save-name)
2020      ("gnus-mh" :interactive t gnus-summary-save-in-folder)
2021      ("gnus-demon" gnus-demon-add-nocem gnus-demon-add-scanmail
2022       gnus-demon-add-rescan gnus-demon-add-scan-timestamps
2023       gnus-demon-add-disconnection gnus-demon-add-handler
2024       gnus-demon-remove-handler)
2025      ("gnus-demon" :interactive t
2026       gnus-demon-init gnus-demon-cancel)
2027      ("gnus-fun" gnus-convert-gray-x-face-to-xpm gnus-display-x-face-in-from
2028       gnus-convert-image-to-gray-x-face)
2029      ("gnus-salt" gnus-highlight-selected-tree gnus-possibly-generate-tree
2030       gnus-tree-open gnus-tree-close gnus-carpal-setup-buffer)
2031      ("gnus-nocem" gnus-nocem-scan-groups gnus-nocem-close
2032       gnus-nocem-unwanted-article-p)
2033      ("gnus-srvr" gnus-enter-server-buffer gnus-server-set-info
2034       gnus-server-server-name)
2035      ("gnus-srvr" gnus-browse-foreign-server)
2036      ("gnus-cite" :interactive t
2037       gnus-article-highlight-citation gnus-article-hide-citation-maybe
2038       gnus-article-hide-citation gnus-article-fill-cited-article
2039       gnus-article-hide-citation-in-followups)
2040      ("gnus-kill" gnus-kill gnus-apply-kill-file-internal
2041       gnus-kill-file-edit-file gnus-kill-file-raise-followups-to-author
2042       gnus-execute gnus-expunge gnus-batch-kill gnus-batch-score)
2043      ("gnus-cache" gnus-cache-possibly-enter-article gnus-cache-save-buffers
2044       gnus-cache-possibly-remove-articles gnus-cache-request-article
2045       gnus-cache-retrieve-headers gnus-cache-possibly-alter-active
2046       gnus-cache-enter-remove-article gnus-cached-article-p
2047       gnus-cache-open gnus-cache-close gnus-cache-update-article
2048       gnus-cache-articles-in-group)
2049      ("gnus-cache" :interactive t gnus-jog-cache gnus-cache-enter-article
2050       gnus-cache-remove-article gnus-summary-insert-cached-articles)
2051      ("gnus-score" :interactive t
2052       gnus-summary-increase-score gnus-summary-set-score
2053       gnus-summary-raise-thread gnus-summary-raise-same-subject
2054       gnus-summary-raise-score gnus-summary-raise-same-subject-and-select
2055       gnus-summary-lower-thread gnus-summary-lower-same-subject
2056       gnus-summary-lower-score gnus-summary-lower-same-subject-and-select
2057       gnus-summary-current-score gnus-score-delta-default
2058       gnus-score-flush-cache gnus-score-close
2059       gnus-possibly-score-headers gnus-score-followup-article
2060       gnus-score-followup-thread)
2061      ("gnus-score"
2062       (gnus-summary-score-map keymap) gnus-score-save gnus-score-headers
2063       gnus-current-score-file-nondirectory gnus-score-adaptive
2064       gnus-score-find-trace gnus-score-file-name)
2065      ("gnus-cus" :interactive t gnus-group-customize gnus-score-customize)
2066      ("gnus-topic" :interactive t gnus-topic-mode)
2067      ("gnus-topic" gnus-topic-remove-group gnus-topic-set-parameters
2068       gnus-subscribe-topics)
2069      ("gnus-salt" :interactive t gnus-pick-mode gnus-binary-mode)
2070      ("gnus-uu" (gnus-uu-extract-map keymap) (gnus-uu-mark-map keymap))
2071      ("gnus-uu" :interactive t
2072       gnus-uu-digest-mail-forward gnus-uu-digest-post-forward
2073       gnus-uu-mark-series gnus-uu-mark-region gnus-uu-mark-buffer
2074       gnus-uu-mark-by-regexp gnus-uu-mark-all
2075       gnus-uu-mark-sparse gnus-uu-mark-thread gnus-uu-decode-uu
2076       gnus-uu-decode-uu-and-save gnus-uu-decode-unshar
2077       gnus-uu-decode-unshar-and-save gnus-uu-decode-save
2078       gnus-uu-decode-binhex gnus-uu-decode-uu-view
2079       gnus-uu-decode-uu-and-save-view gnus-uu-decode-unshar-view
2080       gnus-uu-decode-unshar-and-save-view gnus-uu-decode-save-view
2081       gnus-uu-decode-binhex-view gnus-uu-unmark-thread
2082       gnus-uu-mark-over gnus-uu-post-news)
2083      ("gnus-uu" gnus-uu-delete-work-dir gnus-uu-unmark-thread)
2084      ("gnus-msg" (gnus-summary-send-map keymap)
2085       gnus-article-mail gnus-copy-article-buffer gnus-extended-version)
2086      ("gnus-msg" :interactive t
2087       gnus-group-post-news gnus-group-mail gnus-group-news
2088       gnus-summary-post-news gnus-summary-news-other-window
2089       gnus-summary-followup gnus-summary-followup-with-original
2090       gnus-summary-cancel-article gnus-summary-supersede-article
2091       gnus-post-news gnus-summary-reply gnus-summary-reply-with-original
2092       gnus-summary-mail-forward gnus-summary-mail-other-window
2093       gnus-summary-resend-message gnus-summary-resend-bounced-mail
2094       gnus-summary-wide-reply gnus-summary-followup-to-mail
2095       gnus-summary-followup-to-mail-with-original gnus-bug
2096       gnus-summary-wide-reply-with-original
2097       gnus-summary-post-forward gnus-summary-wide-reply-with-original
2098       gnus-summary-post-forward)
2099      ("gnus-picon" :interactive t gnus-treat-from-picon)
2100      ("gnus-gl" bbb-login bbb-logout bbb-grouplens-group-p
2101       gnus-grouplens-mode)
2102      ("smiley" :interactive t smiley-region)
2103      ("gnus-win" gnus-configure-windows gnus-add-configuration)
2104      ("gnus-sum" gnus-summary-insert-line gnus-summary-read-group
2105       gnus-list-of-unread-articles gnus-list-of-read-articles
2106       gnus-offer-save-summaries gnus-make-thread-indent-array
2107       gnus-summary-exit gnus-update-read-articles gnus-summary-last-subject
2108       gnus-summary-skip-intangible gnus-summary-article-number
2109       gnus-data-header gnus-data-find)
2110      ("gnus-group" gnus-group-insert-group-line gnus-group-quit
2111       gnus-group-list-groups gnus-group-first-unread-group
2112       gnus-group-set-mode-line gnus-group-set-info gnus-group-save-newsrc
2113       gnus-group-setup-buffer gnus-group-get-new-news
2114       gnus-group-make-help-group gnus-group-update-group
2115       gnus-group-iterate gnus-group-group-name)
2116      ("gnus-bcklg" gnus-backlog-request-article gnus-backlog-enter-article
2117       gnus-backlog-remove-article)
2118      ("gnus-art" gnus-article-read-summary-keys gnus-article-save
2119       gnus-article-prepare gnus-article-set-window-start
2120       gnus-article-next-page gnus-article-prev-page
2121       gnus-request-article-this-buffer gnus-article-mode
2122       gnus-article-setup-buffer gnus-narrow-to-page
2123       gnus-article-delete-invisible-text gnus-treat-article)
2124      ("gnus-art" :interactive t
2125       gnus-article-hide-headers gnus-article-hide-boring-headers
2126       gnus-article-treat-overstrike
2127       gnus-article-remove-cr gnus-article-remove-trailing-blank-lines
2128       gnus-article-display-x-face gnus-article-de-quoted-unreadable
2129       gnus-article-de-base64-unreadable
2130       gnus-article-decode-HZ
2131       gnus-article-wash-html
2132       gnus-article-unsplit-urls
2133       gnus-article-hide-pgp
2134       gnus-article-hide-pem gnus-article-hide-signature
2135       gnus-article-strip-leading-blank-lines gnus-article-date-local
2136       gnus-article-date-original gnus-article-date-lapsed
2137 ;;      gnus-article-show-all-headers
2138       gnus-article-edit-mode gnus-article-edit-article
2139       gnus-article-edit-done gnus-article-decode-encoded-words
2140       gnus-start-date-timer gnus-stop-date-timer
2141       gnus-mime-view-all-parts)
2142      ("gnus-int" gnus-request-type)
2143      ("gnus-start" gnus-newsrc-parse-options gnus-1 gnus-no-server-1
2144       gnus-dribble-enter gnus-read-init-file gnus-dribble-touch)
2145      ("gnus-dup" gnus-dup-suppress-articles gnus-dup-unsuppress-article
2146       gnus-dup-enter-articles)
2147      ("gnus-range" gnus-copy-sequence)
2148      ("gnus-eform" gnus-edit-form)
2149      ("gnus-move" :interactive t
2150       gnus-group-move-group-to-server gnus-change-server)
2151      ("gnus-logic" gnus-score-advanced)
2152      ("gnus-undo" gnus-undo-mode gnus-undo-register)
2153      ("gnus-async" gnus-async-request-fetched-article gnus-async-prefetch-next
2154       gnus-async-prefetch-article gnus-async-prefetch-remove-group
2155       gnus-async-halt-prefetch)
2156      ("gnus-agent" gnus-open-agent gnus-agent-get-function
2157       gnus-agent-save-groups gnus-agent-save-active gnus-agent-method-p
2158       gnus-agent-get-undownloaded-list gnus-agent-fetch-session
2159       gnus-summary-set-agent-mark gnus-agent-save-group-info
2160       gnus-agent-request-article gnus-agent-retrieve-headers)
2161      ("gnus-agent" :interactive t
2162       gnus-unplugged gnus-agentize gnus-agent-batch)
2163      ("gnus-vm" :interactive t gnus-summary-save-in-vm
2164       gnus-summary-save-article-vm)
2165      ("compface" uncompface)
2166      ("gnus-draft" :interactive t gnus-draft-mode gnus-group-send-queue)
2167      ("gnus-mlspl" gnus-group-split gnus-group-split-fancy)
2168      ("gnus-mlspl" :interactive t gnus-group-split-setup
2169       gnus-group-split-update))))
2170
2171 ;;; gnus-sum.el thingies
2172
2173
2174 (defcustom gnus-summary-line-format "%U%R%z%I%(%[%4L: %-23,23f%]%) %s\n"
2175   "*The format specification of the lines in the summary buffer.
2176
2177 It works along the same lines as a normal formatting string,
2178 with some simple extensions.
2179
2180 %N   Article number, left padded with spaces (string)
2181 %S   Subject (string)
2182 %s   Subject if it is at the root of a thread, and \"\" otherwise (string)
2183 %n   Name of the poster (string)
2184 %a   Extracted name of the poster (string)
2185 %A   Extracted address of the poster (string)
2186 %F   Contents of the From: header (string)
2187 %f   Contents of the From: or To: headers (string)
2188 %x   Contents of the Xref: header (string)
2189 %D   Date of the article (string)
2190 %d   Date of the article (string) in DD-MMM format
2191 %o   Date of the article (string) in YYYYMMDD`T'HHMMSS format
2192 %M   Message-id of the article (string)
2193 %r   References of the article (string)
2194 %c   Number of characters in the article (integer)
2195 %L   Number of lines in the article (integer)
2196 %I   Indentation based on thread level (a string of spaces)
2197 %B   A complex trn-style thread tree (string)
2198      The variables `gnus-sum-thread-*' can be used for customization.
2199 %T   A string with two possible values: 80 spaces if the article
2200      is on thread level two or larger and 0 spaces on level one
2201 %R   \"A\" if this article has been replied to, \" \" otherwise (character)
2202 %U   Status of this article (character, \"R\", \"K\", \"-\" or \" \")
2203 %[   Opening bracket (character, \"[\" or \"<\")
2204 %]   Closing bracket (character, \"]\" or \">\")
2205 %>   Spaces of length thread-level (string)
2206 %<   Spaces of length (- 20 thread-level) (string)
2207 %i   Article score (number)
2208 %z   Article zcore (character)
2209 %t   Number of articles under the current thread (number).
2210 %e   Whether the thread is empty or not (character).
2211 %l   GroupLens score (string).
2212 %V   Total thread score (number).
2213 %P   The line number (number).
2214 %O   Download mark (character).
2215 %u   User defined specifier.  The next character in the format string should
2216      be a letter.  Gnus will call the function gnus-user-format-function-X,
2217      where X is the letter following %u.  The function will be passed the
2218      current header as argument.  The function should return a string, which
2219      will be inserted into the summary just like information from any other
2220      summary specifier.
2221
2222 The %U (status), %R (replied) and %z (zcore) specs have to be handled
2223 with care.  For reasons of efficiency, Gnus will compute what column
2224 these characters will end up in, and \"hard-code\" that.  This means that
2225 it is invalid to have these specs after a variable-length spec.  Well,
2226 you might not be arrested, but your summary buffer will look strange,
2227 which is bad enough.
2228
2229 The smart choice is to have these specs as far to the left as
2230 possible.
2231
2232 This restriction may disappear in later versions of Gnus.
2233
2234 General format specifiers can also be used.
2235 See `(gnus)Formatting Variables'."
2236   :link '(custom-manual "(gnus)Formatting Variables")
2237   :type 'string
2238   :group 'gnus-summary-format)
2239
2240 ;;;
2241 ;;; Skeleton keymaps
2242 ;;;
2243
2244 (defun gnus-suppress-keymap (keymap)
2245   (suppress-keymap keymap)
2246   (let ((keys `([backspace] [delete] "\177" "\M-u"))) ;gnus-mouse-2
2247     (while keys
2248       (define-key keymap (pop keys) 'undefined))))
2249
2250 (defvar gnus-article-mode-map
2251   (let ((keymap (make-sparse-keymap)))
2252     (gnus-suppress-keymap keymap)
2253     keymap))
2254 (defvar gnus-summary-mode-map
2255   (let ((keymap (make-keymap)))
2256     (gnus-suppress-keymap keymap)
2257     keymap))
2258 (defvar gnus-group-mode-map
2259   (let ((keymap (make-keymap)))
2260     (gnus-suppress-keymap keymap)
2261     keymap))
2262
2263 \f
2264
2265 ;; Fix by Hallvard B Furuseth <h.b.furuseth@usit.uio.no>.
2266 ;; If you want the cursor to go somewhere else, set these two
2267 ;; functions in some startup hook to whatever you want.
2268 (defalias 'gnus-summary-position-point 'gnus-goto-colon)
2269 (defalias 'gnus-group-position-point 'gnus-goto-colon)
2270
2271 ;;; Various macros and substs.
2272
2273 (defun gnus-header-from (header)
2274   (mail-header-from header))
2275
2276 (defmacro gnus-gethash (string hashtable)
2277   "Get hash value of STRING in HASHTABLE."
2278   `(symbol-value (intern-soft ,string ,hashtable)))
2279
2280 (defmacro gnus-gethash-safe (string hashtable)
2281   "Get hash value of STRING in HASHTABLE.
2282 Return nil if not defined."
2283   `(let ((sym (intern-soft ,string ,hashtable)))
2284      (and (boundp sym) (symbol-value sym))))
2285
2286 (defmacro gnus-sethash (string value hashtable)
2287   "Set hash value.  Arguments are STRING, VALUE, and HASHTABLE."
2288   `(set (intern ,string ,hashtable) ,value))
2289 (put 'gnus-sethash 'edebug-form-spec '(form form form))
2290
2291 (defmacro gnus-group-unread (group)
2292   "Get the currently computed number of unread articles in GROUP."
2293   `(car (gnus-gethash ,group gnus-newsrc-hashtb)))
2294
2295 (defmacro gnus-group-entry (group)
2296   "Get the newsrc entry for GROUP."
2297   `(gnus-gethash ,group gnus-newsrc-hashtb))
2298
2299 (defmacro gnus-active (group)
2300   "Get active info on GROUP."
2301   `(gnus-gethash ,group gnus-active-hashtb))
2302
2303 (defmacro gnus-set-active (group active)
2304   "Set GROUP's active info."
2305   `(gnus-sethash ,group ,active gnus-active-hashtb))
2306
2307 ;; Info access macros.
2308
2309 (defmacro gnus-info-group (info)
2310   `(nth 0 ,info))
2311 (defmacro gnus-info-rank (info)
2312   `(nth 1 ,info))
2313 (defmacro gnus-info-read (info)
2314   `(nth 2 ,info))
2315 (defmacro gnus-info-marks (info)
2316   `(nth 3 ,info))
2317 (defmacro gnus-info-method (info)
2318   `(nth 4 ,info))
2319 (defmacro gnus-info-params (info)
2320   `(nth 5 ,info))
2321
2322 (defmacro gnus-info-level (info)
2323   `(let ((rank (gnus-info-rank ,info)))
2324      (if (consp rank)
2325          (car rank)
2326        rank)))
2327 (defmacro gnus-info-score (info)
2328   `(let ((rank (gnus-info-rank ,info)))
2329      (or (and (consp rank) (cdr rank)) 0)))
2330
2331 (defmacro gnus-info-set-group (info group)
2332   `(setcar ,info ,group))
2333 (defmacro gnus-info-set-rank (info rank)
2334   `(setcar (nthcdr 1 ,info) ,rank))
2335 (defmacro gnus-info-set-read (info read)
2336   `(setcar (nthcdr 2 ,info) ,read))
2337 (defmacro gnus-info-set-marks (info marks &optional extend)
2338   (if extend
2339       `(gnus-info-set-entry ,info ,marks 3)
2340     `(setcar (nthcdr 3 ,info) ,marks)))
2341 (defmacro gnus-info-set-method (info method &optional extend)
2342   (if extend
2343       `(gnus-info-set-entry ,info ,method 4)
2344     `(setcar (nthcdr 4 ,info) ,method)))
2345 (defmacro gnus-info-set-params (info params &optional extend)
2346   (if extend
2347       `(gnus-info-set-entry ,info ,params 5)
2348     `(setcar (nthcdr 5 ,info) ,params)))
2349
2350 (defun gnus-info-set-entry (info entry number)
2351   ;; Extend the info until we have enough elements.
2352   (while (<= (length info) number)
2353     (nconc info (list nil)))
2354   ;; Set the entry.
2355   (setcar (nthcdr number info) entry))
2356
2357 (defmacro gnus-info-set-level (info level)
2358   `(let ((rank (cdr ,info)))
2359      (if (consp (car rank))
2360          (setcar (car rank) ,level)
2361        (setcar rank ,level))))
2362 (defmacro gnus-info-set-score (info score)
2363   `(let ((rank (cdr ,info)))
2364      (if (consp (car rank))
2365          (setcdr (car rank) ,score)
2366        (setcar rank (cons (car rank) ,score)))))
2367
2368 (defmacro gnus-get-info (group)
2369   `(nth 2 (gnus-gethash ,group gnus-newsrc-hashtb)))
2370
2371 ;;; Load the compatability functions.
2372
2373 (require 'gnus-ems)
2374
2375 \f
2376 ;;;
2377 ;;; Shutdown
2378 ;;;
2379
2380 (defvar gnus-shutdown-alist nil)
2381
2382 (defun gnus-add-shutdown (function &rest symbols)
2383   "Run FUNCTION whenever one of SYMBOLS is shut down."
2384   (push (cons function symbols) gnus-shutdown-alist))
2385
2386 (defun gnus-shutdown (symbol)
2387   "Shut down everything that waits for SYMBOL."
2388   (let ((alist gnus-shutdown-alist)
2389         entry)
2390     (while (setq entry (pop alist))
2391       (when (memq symbol (cdr entry))
2392         (funcall (car entry))))))
2393
2394 \f
2395 ;;;
2396 ;;; Gnus Utility Functions
2397 ;;;
2398
2399 (defun gnus-find-subscribed-addresses ()
2400   "Return a regexp matching the addresses of all subscribed mail groups.
2401 It consists of the `to-address' or `to-list' parameter of all groups
2402 with a `subscribed' parameter."
2403   (let (group address addresses)
2404     (dolist (entry (cdr gnus-newsrc-alist))
2405       (setq group (car entry))
2406       (when (gnus-group-find-parameter group 'subscribed)
2407         (setq address (or (gnus-group-fast-parameter group 'to-address)
2408                           (gnus-group-fast-parameter group 'to-list)))
2409         (when address
2410           (push address addresses))))
2411     (list (mapconcat 'regexp-quote addresses "\\|"))))
2412
2413 (defmacro gnus-string-or (&rest strings)
2414   "Return the first element of STRINGS that is a non-blank string.
2415 STRINGS will be evaluated in normal `or' order."
2416   `(gnus-string-or-1 ',strings))
2417
2418 (defun gnus-string-or-1 (strings)
2419   (let (string)
2420     (while strings
2421       (setq string (eval (pop strings)))
2422       (if (string-match "^[ \t]*$" string)
2423           (setq string nil)
2424         (setq strings nil)))
2425     string))
2426
2427 (defun gnus-version (&optional arg)
2428   "Version number of this version of Gnus.
2429 If ARG, insert string at point."
2430   (interactive "P")
2431   (if arg
2432       (insert (message gnus-version))
2433     (message gnus-version)))
2434
2435 (defun gnus-continuum-version (&optional version)
2436   "Return VERSION as a floating point number."
2437   (interactive)
2438   (unless version
2439     (setq version gnus-version))
2440   (when (or (string-match "^\\([^ ]+\\)? ?Gnus v?\\([0-9.]+\\)$" version)
2441             (string-match "^\\(.?\\)gnus-\\([0-9.]+\\)$" version))
2442     (let ((alpha (and (match-beginning 1) (match-string 1 version)))
2443           (number (match-string 2 version))
2444           major minor least)
2445       (unless (string-match
2446                "\\([0-9]\\)\\.\\([0-9]+\\)\\.?\\([0-9]+\\)?" number)
2447         (error "Invalid version string: %s" version))
2448       (setq major (string-to-number (match-string 1 number))
2449             minor (string-to-number (match-string 2 number))
2450             least (if (match-beginning 3)
2451                       (string-to-number (match-string 3 number))
2452                     0))
2453       (string-to-number
2454        (if (zerop major)
2455              (format "%s00%02d%02d"
2456                      (if (member alpha '("(ding)" "d"))
2457                          "4.99"
2458                        (+ 5 (* 0.02
2459                                (abs
2460                                 (- (mm-char-int (aref (downcase alpha) 0))
2461                                    (mm-char-int ?t))))
2462                           -0.01))
2463                      minor least)
2464          (format "%d.%02d%02d" major minor least))))))
2465
2466 (defun gnus-info-find-node (&optional nodename)
2467   "Find Info documentation of Gnus."
2468   (interactive)
2469   ;; Enlarge info window if needed.
2470   (let (gnus-info-buffer)
2471     (Info-goto-node (or nodename (cadr (assq major-mode gnus-info-nodes))))
2472     (setq gnus-info-buffer (current-buffer))
2473     (gnus-configure-windows 'info)))
2474
2475 ;;;
2476 ;;; gnus-interactive
2477 ;;;
2478
2479 (defvar gnus-current-prefix-symbol nil
2480   "Current prefix symbol.")
2481
2482 (defvar gnus-current-prefix-symbols nil
2483   "List of current prefix symbols.")
2484
2485 (defun gnus-interactive (string &optional params)
2486   "Return a list that can be fed to `interactive'.
2487 See `interactive' for full documentation.
2488
2489 Adds the following specs:
2490
2491 y -- The current symbolic prefix.
2492 Y -- A list of the current symbolic prefix(es).
2493 A -- Article number.
2494 H -- Article header.
2495 g -- Group name."
2496   (let ((i 0)
2497         out c prompt)
2498     (while (< i (length string))
2499       (string-match ".\\([^\n]*\\)\n?" string i)
2500       (setq c (aref string i))
2501       (when (match-end 1)
2502         (setq prompt (match-string 1 string)))
2503       (setq i (match-end 0))
2504       ;; We basically emulate just about everything that
2505       ;; `interactive' does, but add the specs listed above.
2506       (push
2507        (cond
2508         ((= c ?a)
2509          (completing-read prompt obarray 'fboundp t))
2510         ((= c ?b)
2511          (read-buffer prompt (current-buffer) t))
2512         ((= c ?B)
2513          (read-buffer prompt (other-buffer (current-buffer))))
2514         ((= c ?c)
2515          (read-char))
2516         ((= c ?C)
2517          (completing-read prompt obarray 'commandp t))
2518         ((= c ?d)
2519          (point))
2520         ((= c ?D)
2521          (read-file-name prompt nil default-directory 'lambda))
2522         ((= c ?f)
2523          (read-file-name prompt nil nil 'lambda))
2524         ((= c ?F)
2525          (read-file-name prompt))
2526         ((= c ?k)
2527          (read-key-sequence prompt))
2528         ((= c ?K)
2529          (error "Not implemented spec"))
2530         ((= c ?e)
2531          (error "Not implemented spec"))
2532         ((= c ?m)
2533          (mark))
2534         ((= c ?N)
2535          (error "Not implemented spec"))
2536         ((= c ?n)
2537          (string-to-number (read-from-minibuffer prompt)))
2538         ((= c ?p)
2539          (prefix-numeric-value current-prefix-arg))
2540         ((= c ?P)
2541          current-prefix-arg)
2542         ((= c ?r)
2543          'gnus-prefix-nil)
2544         ((= c ?s)
2545          (read-string prompt))
2546         ((= c ?S)
2547          (intern (read-string prompt)))
2548         ((= c ?v)
2549          (read-variable prompt))
2550         ((= c ?x)
2551          (read-minibuffer prompt))
2552         ((= c ?x)
2553          (eval-minibuffer prompt))
2554         ;; And here the new specs come.
2555         ((= c ?y)
2556          gnus-current-prefix-symbol)
2557         ((= c ?Y)
2558          gnus-current-prefix-symbols)
2559         ((= c ?g)
2560          (gnus-group-group-name))
2561         ((= c ?A)
2562          (gnus-summary-skip-intangible)
2563          (or (get-text-property (point) 'gnus-number)
2564              (gnus-summary-last-subject)))
2565         ((= c ?H)
2566          (gnus-data-header (gnus-data-find (gnus-summary-article-number))))
2567         (t
2568          (error "Non-implemented spec")))
2569        out)
2570       (cond
2571        ((= c ?r)
2572         (push (if (< (point) (mark)) (point) (mark)) out)
2573         (push (if (> (point) (mark)) (point) (mark)) out))))
2574     (setq out (delq 'gnus-prefix-nil out))
2575     (nreverse out)))
2576
2577 (defun gnus-symbolic-argument (&optional arg)
2578   "Read a symbolic argument and a command, and then execute command."
2579   (interactive "P")
2580   (let* ((in-command (this-command-keys))
2581          (command in-command)
2582          gnus-current-prefix-symbols
2583          gnus-current-prefix-symbol
2584          syms)
2585     (while (equal in-command command)
2586       (message "%s-" (key-description (this-command-keys)))
2587       (push (intern (char-to-string (read-char))) syms)
2588       (setq command (read-key-sequence nil t)))
2589     (setq gnus-current-prefix-symbols (nreverse syms)
2590           gnus-current-prefix-symbol (car gnus-current-prefix-symbols))
2591     (call-interactively (key-binding command t))))
2592
2593 ;;; More various functions.
2594
2595 (defsubst gnus-check-backend-function (func group)
2596   "Check whether GROUP supports function FUNC.
2597 GROUP can either be a string (a group name) or a select method."
2598   (ignore-errors
2599     (let ((method (if (stringp group)
2600                       (car (gnus-find-method-for-group group))
2601                     group)))
2602       (unless (featurep method)
2603         (require method))
2604       (fboundp (intern (format "%s-%s" method func))))))
2605
2606 (defun gnus-group-read-only-p (&optional group)
2607   "Check whether GROUP supports editing or not.
2608 If GROUP is nil, `gnus-newsgroup-name' will be checked instead.  Note
2609 that that variable is buffer-local to the summary buffers."
2610   (let ((group (or group gnus-newsgroup-name)))
2611     (not (gnus-check-backend-function 'request-replace-article group))))
2612
2613 (defun gnus-virtual-group-p (group)
2614   "Say whether GROUP is virtual or not."
2615   (memq 'virtual (assoc (symbol-name (car (gnus-find-method-for-group group)))
2616                         gnus-valid-select-methods)))
2617
2618 (defun gnus-news-group-p (group &optional article)
2619   "Return non-nil if GROUP (and ARTICLE) come from a news server."
2620   (cond ((gnus-member-of-valid 'post group) ;Ordinary news group
2621          t)                             ;is news of course.
2622         ((not (gnus-member-of-valid 'post-mail group)) ;Non-combined.
2623          nil)                           ;must be mail then.
2624         ((vectorp article)              ;Has header info.
2625          (eq (gnus-request-type group (mail-header-id article)) 'news))
2626         ((null article)                 ;Hasn't header info
2627          (eq (gnus-request-type group) 'news)) ;(unknown ==> mail)
2628         ((< article 0)                  ;Virtual message
2629          nil)                           ;we don't know, guess mail.
2630         (t                              ;Has positive number
2631          (eq (gnus-request-type group article) 'news)))) ;use it.
2632
2633 ;; Returns a list of writable groups.
2634 (defun gnus-writable-groups ()
2635   (let ((alist gnus-newsrc-alist)
2636         groups group)
2637     (while (setq group (car (pop alist)))
2638       (unless (gnus-group-read-only-p group)
2639         (push group groups)))
2640     (nreverse groups)))
2641
2642 ;; Check whether to use long file names.
2643 (defun gnus-use-long-file-name (symbol)
2644   ;; The variable has to be set...
2645   (and gnus-use-long-file-name
2646        ;; If it isn't a list, then we return t.
2647        (or (not (listp gnus-use-long-file-name))
2648            ;; If it is a list, and the list contains `symbol', we
2649            ;; return nil.
2650            (not (memq symbol gnus-use-long-file-name)))))
2651
2652 ;; Generate a unique new group name.
2653 (defun gnus-generate-new-group-name (leaf)
2654   (let ((name leaf)
2655         (num 0))
2656     (while (gnus-gethash name gnus-newsrc-hashtb)
2657       (setq name (concat leaf "<" (int-to-string (setq num (1+ num))) ">")))
2658     name))
2659
2660 (defun gnus-ephemeral-group-p (group)
2661   "Say whether GROUP is ephemeral or not."
2662   (gnus-group-get-parameter group 'quit-config t))
2663
2664 (defun gnus-group-quit-config (group)
2665   "Return the quit-config of GROUP."
2666   (gnus-group-get-parameter group 'quit-config t))
2667
2668 (defun gnus-kill-ephemeral-group (group)
2669   "Remove ephemeral GROUP from relevant structures."
2670   (gnus-sethash group nil gnus-newsrc-hashtb))
2671
2672 (defun gnus-simplify-mode-line ()
2673   "Make mode lines a bit simpler."
2674   (setq mode-line-modified (cdr gnus-mode-line-modified))
2675   (when (listp mode-line-format)
2676     (make-local-variable 'mode-line-format)
2677     (setq mode-line-format (copy-sequence mode-line-format))
2678     (when (equal (nth 3 mode-line-format) "   ")
2679       (setcar (nthcdr 3 mode-line-format) " "))))
2680
2681 ;;; Servers and groups.
2682
2683 (defsubst gnus-server-add-address (method)
2684   (let ((method-name (symbol-name (car method))))
2685     (if (and (memq 'address (assoc method-name gnus-valid-select-methods))
2686              (not (assq (intern (concat method-name "-address")) method))
2687              (memq 'physical-address (assq (car method)
2688                                            gnus-valid-select-methods)))
2689         (append method (list (list (intern (concat method-name "-address"))
2690                                    (nth 1 method))))
2691       method)))
2692
2693 (defsubst gnus-server-to-method (server)
2694   "Map virtual server names to select methods."
2695   (or (and server (listp server) server)
2696       (cdr (assoc server gnus-server-method-cache))
2697       (let ((result
2698              (or
2699               ;; Perhaps this is the native server?
2700               (and (equal server "native") gnus-select-method)
2701               ;; It should be in the server alist.
2702               (cdr (assoc server gnus-server-alist))
2703               ;; It could be in the predefined server alist.
2704               (cdr (assoc server gnus-predefined-server-alist))
2705               ;; If not, we look through all the opened server
2706               ;; to see whether we can find it there.
2707               (let ((opened gnus-opened-servers))
2708                 (while (and opened
2709                             (not (equal server (format "%s:%s" (caaar opened)
2710                                                        (cadaar opened)))))
2711                   (pop opened))
2712                 (caar opened))
2713               ;; It could be a named method, search all servers
2714               (let ((servers gnus-secondary-select-methods))
2715                 (while (and servers
2716                             (not (equal server (format "%s:%s" (caar servers)
2717                                                        (cadar servers)))))
2718                   (pop servers))
2719                 (car servers)))))
2720         (push (cons server result) gnus-server-method-cache)
2721         result)))
2722
2723 (defsubst gnus-server-get-method (group method)
2724   ;; Input either a server name, and extended server name, or a
2725   ;; select method, and return a select method.
2726   (cond ((stringp method)
2727          (gnus-server-to-method method))
2728         ((equal method gnus-select-method)
2729          gnus-select-method)
2730         ((and (stringp (car method))
2731               group)
2732          (gnus-server-extend-method group method))
2733         ((and method
2734               (not group)
2735               (equal (cadr method) ""))
2736          method)
2737         (t
2738          (gnus-server-add-address method))))
2739
2740 (defmacro gnus-method-equal (ss1 ss2)
2741   "Say whether two servers are equal."
2742   `(let ((s1 ,ss1)
2743          (s2 ,ss2))
2744      (or (equal s1 s2)
2745          (and (= (length s1) (length s2))
2746               (progn
2747                 (while (and s1 (member (car s1) s2))
2748                   (setq s1 (cdr s1)))
2749                 (null s1))))))
2750
2751 (defun gnus-methods-equal-p (m1 m2)
2752   (let ((m1 (or m1 gnus-select-method))
2753         (m2 (or m2 gnus-select-method)))
2754     (or (equal m1 m2)
2755         (and (eq (car m1) (car m2))
2756              (or (not (memq 'address (assoc (symbol-name (car m1))
2757                                             gnus-valid-select-methods)))
2758                  (equal (nth 1 m1) (nth 1 m2)))))))
2759
2760 (defun gnus-server-equal (m1 m2)
2761   "Say whether two methods are equal."
2762   (let ((m1 (cond ((null m1) gnus-select-method)
2763                   ((stringp m1) (gnus-server-to-method m1))
2764                   (t m1)))
2765         (m2 (cond ((null m2) gnus-select-method)
2766                   ((stringp m2) (gnus-server-to-method m2))
2767                   (t m2))))
2768     (gnus-method-equal m1 m2)))
2769
2770 (defun gnus-servers-using-backend (backend)
2771   "Return a list of known servers using BACKEND."
2772   (let ((opened gnus-opened-servers)
2773         out)
2774     (while opened
2775       (when (eq backend (caaar opened))
2776         (push (caar opened) out))
2777       (pop opened))
2778     out))
2779
2780 (defun gnus-archive-server-wanted-p ()
2781   "Say whether the user wants to use the archive server."
2782   (cond
2783    ((or (not gnus-message-archive-method)
2784         (not gnus-message-archive-group))
2785     nil)
2786    ((and gnus-message-archive-method gnus-message-archive-group)
2787     t)
2788    (t
2789     (let ((active (cadr (assq 'nnfolder-active-file
2790                               gnus-message-archive-method))))
2791       (and active
2792            (file-exists-p active))))))
2793
2794 (defsubst gnus-method-to-server-name (method)
2795   (concat
2796    (format "%s" (car method))
2797    (when (and
2798           (or (assoc (format "%s" (car method))
2799                      (gnus-methods-using 'address))
2800               (gnus-server-equal method gnus-message-archive-method))
2801           (nth 1 method)
2802           (not (string= (nth 1 method) "")))
2803      (concat "+" (nth 1 method)))))
2804
2805 (defsubst gnus-method-to-full-server-name (method)
2806   (format "%s+%s" (car method) (nth 1 method)))
2807
2808 (defun gnus-group-prefixed-name (group method)
2809   "Return the whole name from GROUP and METHOD."
2810   (and (stringp method) (setq method (gnus-server-to-method method)))
2811   (if (or (not method)
2812           (gnus-server-equal method "native")
2813           (string-match ":" group))
2814       group
2815     (concat (gnus-method-to-server-name method) ":" group)))
2816
2817 (defun gnus-group-real-prefix (group)
2818   "Return the prefix of the current group name."
2819   (if (string-match "^[^:]+:" group)
2820       (substring group 0 (match-end 0))
2821     ""))
2822
2823 (defun gnus-group-method (group)
2824   "Return the server or method used for selecting GROUP.
2825 You should probably use `gnus-find-method-for-group' instead."
2826   (let ((prefix (gnus-group-real-prefix group)))
2827     (if (equal prefix "")
2828         gnus-select-method
2829       (let ((servers gnus-opened-servers)
2830             (server "")
2831             backend possible found)
2832         (if (string-match "^[^\\+]+\\+" prefix)
2833             (setq backend (intern (substring prefix 0 (1- (match-end 0))))
2834                   server (substring prefix (match-end 0) (1- (length prefix))))
2835           (setq backend (intern (substring prefix 0 (1- (length prefix))))))
2836         (while servers
2837           (when (eq (caaar servers) backend)
2838             (setq possible (caar servers))
2839             (when (equal (cadaar servers) server)
2840               (setq found (caar servers))))
2841           (pop servers))
2842         (or (car (rassoc found gnus-server-alist))
2843             found
2844             (car (rassoc possible gnus-server-alist))
2845             possible
2846             (list backend server))))))
2847
2848 (defsubst gnus-native-method-p (method)
2849   "Return whether METHOD is the native select method."
2850   (gnus-method-equal method gnus-select-method))
2851
2852 (defsubst gnus-secondary-method-p (method)
2853   "Return whether METHOD is a secondary select method."
2854   (let ((methods gnus-secondary-select-methods)
2855         (gmethod (gnus-server-get-method nil method)))
2856     (while (and methods
2857                 (not (gnus-method-equal
2858                       (gnus-server-get-method nil (car methods))
2859                       gmethod)))
2860       (setq methods (cdr methods)))
2861     methods))
2862
2863 (defun gnus-method-simplify (method)
2864   "Return the shortest uniquely identifying string or method for METHOD."
2865   (cond ((stringp method)
2866          method)
2867         ((gnus-native-method-p method)
2868          nil)
2869         ((gnus-secondary-method-p method)
2870          (format "%s:%s" (nth 0 method) (nth 1 method)))
2871         (t
2872          method)))
2873
2874 (defun gnus-groups-from-server (server)
2875   "Return a list of all groups that are fetched from SERVER."
2876   (let ((alist (cdr gnus-newsrc-alist))
2877         info groups)
2878     (while (setq info (pop alist))
2879       (when (gnus-server-equal (gnus-info-method info) server)
2880         (push (gnus-info-group info) groups)))
2881     (sort groups 'string<)))
2882
2883 (defun gnus-group-foreign-p (group)
2884   "Say whether a group is foreign or not."
2885   (and (not (gnus-group-native-p group))
2886        (not (gnus-group-secondary-p group))))
2887
2888 (defun gnus-group-native-p (group)
2889   "Say whether the group is native or not."
2890   (not (string-match ":" group)))
2891
2892 (defun gnus-group-secondary-p (group)
2893   "Say whether the group is secondary or not."
2894   (gnus-secondary-method-p (gnus-find-method-for-group group)))
2895
2896 (defun gnus-parameters-get-parameter (group)
2897   "Return the group parameters for GROUP from `gnus-parameters'."
2898   (let (params-list)
2899     (dolist (elem gnus-parameters)
2900       (when (string-match (car elem) group)
2901         (setq params-list
2902               (nconc (gnus-expand-group-parameters
2903                       (car elem) (cdr elem) group)
2904                      params-list))))
2905     params-list))
2906
2907 (defun gnus-expand-group-parameter (match value group)
2908   "Use MATCH to expand VALUE in GROUP."
2909   (with-temp-buffer
2910     (insert group)
2911     (goto-char (point-min))
2912     (while (re-search-forward match nil t)
2913       (replace-match value))
2914     (buffer-string)))
2915
2916 (defun gnus-expand-group-parameters (match parameters group)
2917   "Go through PARAMETERS and expand them according to the match data."
2918   (let (new)
2919     (dolist (elem parameters)
2920       (if (and (stringp (cdr elem))
2921                (string-match "\\\\[0-9&]" (cdr elem)))
2922           (push (cons (car elem)
2923                       (gnus-expand-group-parameter match (cdr elem) group))
2924                 new)
2925         (push elem new)))
2926     new))
2927
2928 (defun gnus-group-fast-parameter (group symbol &optional allow-list)
2929   "For GROUP, return the value of SYMBOL.
2930
2931 You should call this in the `gnus-group-buffer' buffer.
2932 The function `gnus-group-find-parameter' will do that for you."
2933   ;; The speed trick:  No cons'ing and quit early.
2934   (or (let ((params (funcall gnus-group-get-parameter-function group)))
2935         ;; Start easy, check the "real" group parameters.
2936         (gnus-group-parameter-value params symbol allow-list))
2937       ;; We didn't found it there, try `gnus-parameters'.
2938       (let ((result nil)
2939             (head nil)
2940             (tail gnus-parameters))
2941         ;; A good old-fashioned non-cl loop.
2942         (while tail
2943           (setq head (car tail)
2944                 tail (cdr tail))
2945           ;; The car is regexp matching for matching the group name.
2946           (when (string-match (car head) group)
2947             ;; The cdr is the parameters.
2948             (setq result (gnus-group-parameter-value (cdr head)
2949                                                      symbol allow-list))
2950             (when result
2951               ;; Expand if necessary.
2952               (if (and (stringp result) (string-match "\\\\[0-9&]" result))
2953                   (setq result (gnus-expand-group-parameter (car head)
2954                                                             result group)))
2955               ;; Exit the loop early.
2956               (setq tail nil))))
2957         ;; Done.
2958         result)))
2959
2960 (defun gnus-group-find-parameter (group &optional symbol allow-list)
2961   "Return the group parameters for GROUP.
2962 If SYMBOL, return the value of that symbol in the group parameters.
2963
2964 If you call this function inside a loop, consider using the faster
2965 `gnus-group-fast-parameter' instead."
2966   (save-excursion
2967     (set-buffer gnus-group-buffer)
2968     (if symbol
2969         (gnus-group-fast-parameter group symbol allow-list)
2970       (nconc
2971        (copy-sequence
2972         (funcall gnus-group-get-parameter-function group))
2973        (gnus-parameters-get-parameter group)))))
2974
2975 (defun gnus-group-get-parameter (group &optional symbol allow-list)
2976   "Return the group parameters for GROUP.
2977 If SYMBOL, return the value of that symbol in the group parameters.
2978 Most functions should use `gnus-group-find-parameter', which
2979 also examines the topic parameters."
2980   (let ((params (gnus-info-params (gnus-get-info group))))
2981     (if symbol
2982         (gnus-group-parameter-value params symbol allow-list)
2983       params)))
2984
2985 (defun gnus-group-parameter-value (params symbol &optional allow-list)
2986   "Return the value of SYMBOL in group PARAMS."
2987   ;; We only wish to return group parameters (dotted lists) and
2988   ;; not local variables, which may have the same names.
2989   ;; But first we handle single elements...
2990   (or (car (memq symbol params))
2991       ;; Handle alist.
2992       (let (elem)
2993         (catch 'found
2994           (while (setq elem (pop params))
2995             (when (and (consp elem)
2996                        (eq (car elem) symbol)
2997                        (or allow-list
2998                            (atom (cdr elem))))
2999               (throw 'found (cdr elem))))))))
3000
3001 (defun gnus-group-add-parameter (group param)
3002   "Add parameter PARAM to GROUP."
3003   (let ((info (gnus-get-info group)))
3004     (when info
3005       (gnus-group-remove-parameter group (if (consp param) (car param) param))
3006       ;; Cons the new param to the old one and update.
3007       (gnus-group-set-info (cons param (gnus-info-params info))
3008                            group 'params))))
3009
3010 (defun gnus-group-set-parameter (group name value)
3011   "Set parameter NAME to VALUE in GROUP."
3012   (let ((info (gnus-get-info group)))
3013     (when info
3014       (gnus-group-remove-parameter group name)
3015       (let ((old-params (gnus-info-params info))
3016             (new-params (list (cons name value))))
3017         (while old-params
3018           (when (or (not (listp (car old-params)))
3019                     (not (eq (caar old-params) name)))
3020             (setq new-params (append new-params (list (car old-params)))))
3021           (setq old-params (cdr old-params)))
3022         (gnus-group-set-info new-params group 'params)))))
3023
3024 (defun gnus-group-remove-parameter (group name)
3025   "Remove parameter NAME from GROUP."
3026   (let ((info (gnus-get-info group)))
3027     (when info
3028       (let ((params (gnus-info-params info)))
3029         (when params
3030           (setq params (delq name params))
3031           (while (assq name params)
3032             (gnus-pull name params))
3033           (gnus-info-set-params info params))))))
3034
3035 (defun gnus-group-add-score (group &optional score)
3036   "Add SCORE to the GROUP score.
3037 If SCORE is nil, add 1 to the score of GROUP."
3038   (let ((info (gnus-get-info group)))
3039     (when info
3040       (gnus-info-set-score info (+ (gnus-info-score info) (or score 1))))))
3041
3042 (defun gnus-short-group-name (group &optional levels)
3043   "Collapse GROUP name LEVELS.
3044 Select methods are stripped and any remote host name is stripped down to
3045 just the host name."
3046   (let* ((name "")
3047          (foreign "")
3048          (depth 0)
3049          (skip 1)
3050          (levels (or levels
3051                      gnus-group-uncollapsed-levels
3052                      (progn
3053                        (while (string-match "\\." group skip)
3054                          (setq skip (match-end 0)
3055                                depth (+ depth 1)))
3056                        depth))))
3057     ;; Separate foreign select method from group name and collapse.
3058    ;; If method contains a server, collapse to non-domain server name,
3059     ;; otherwise collapse to select method.
3060     (let* ((colon (string-match ":" group))
3061            (server (and colon (substring group 0 colon)))
3062            (plus (and server (string-match "+" server))))
3063       (when server
3064         (if plus
3065             (setq foreign (substring server (+ 1 plus)
3066                                      (string-match "\\." server))
3067                   group (substring group (+ 1 colon)))
3068           (setq foreign server
3069                 group (substring group (+ 1 colon))))
3070         (setq foreign (concat foreign ":")))
3071       ;; Collapse group name leaving LEVELS uncollapsed elements
3072       (let* ((slist (split-string group "/"))
3073              (slen (length slist))
3074              (dlist (split-string group "\\."))
3075              (dlen (length dlist))
3076              glist
3077              glen
3078              gsep
3079              res)
3080         (if (> slen dlen)
3081             (setq glist slist
3082                   glen slen
3083                   gsep "/")
3084           (setq glist dlist
3085                 glen dlen
3086                 gsep "."))
3087         (setq levels (- glen levels))
3088         (dolist (g glist)
3089           (push (if (>= (decf levels) 0)
3090                     (if (zerop (length g))
3091                         ""
3092                       (substring g 0 1))
3093                   g)
3094                 res))
3095         (concat foreign (mapconcat 'identity (nreverse res) gsep))))))
3096
3097 (defun gnus-narrow-to-body ()
3098   "Narrow to the body of an article."
3099   (narrow-to-region
3100    (progn
3101      (goto-char (point-min))
3102      (or (search-forward "\n\n" nil t)
3103          (point-max)))
3104    (point-max)))
3105
3106 \f
3107 ;;;
3108 ;;; Kill file handling.
3109 ;;;
3110
3111 (defun gnus-apply-kill-file ()
3112   "Apply a kill file to the current newsgroup.
3113 Returns the number of articles marked as read."
3114   (if (or (file-exists-p (gnus-newsgroup-kill-file nil))
3115           (file-exists-p (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3116       (gnus-apply-kill-file-internal)
3117     0))
3118
3119 (defun gnus-kill-save-kill-buffer ()
3120   (let ((file (gnus-newsgroup-kill-file gnus-newsgroup-name)))
3121     (when (get-file-buffer file)
3122       (save-excursion
3123         (set-buffer (get-file-buffer file))
3124         (when (buffer-modified-p)
3125           (save-buffer))
3126         (kill-buffer (current-buffer))))))
3127
3128 (defcustom gnus-kill-file-name "KILL"
3129   "Suffix of the kill files."
3130   :group 'gnus-score-kill
3131   :group 'gnus-score-files
3132   :type 'string)
3133
3134 (defun gnus-newsgroup-kill-file (newsgroup)
3135   "Return the name of a kill file name for NEWSGROUP.
3136 If NEWSGROUP is nil, return the global kill file name instead."
3137   (cond
3138    ;; The global KILL file is placed at top of the directory.
3139    ((or (null newsgroup)
3140         (string-equal newsgroup ""))
3141     (expand-file-name gnus-kill-file-name
3142                       gnus-kill-files-directory))
3143    ;; Append ".KILL" to newsgroup name.
3144    ((gnus-use-long-file-name 'not-kill)
3145     (expand-file-name (concat (gnus-newsgroup-savable-name newsgroup)
3146                               "." gnus-kill-file-name)
3147                       gnus-kill-files-directory))
3148    ;; Place "KILL" under the hierarchical directory.
3149    (t
3150     (expand-file-name (concat (gnus-newsgroup-directory-form newsgroup)
3151                               "/" gnus-kill-file-name)
3152                       gnus-kill-files-directory))))
3153
3154 ;;; Server things.
3155
3156 (defun gnus-member-of-valid (symbol group)
3157   "Find out if GROUP has SYMBOL as part of its \"valid\" spec."
3158   (memq symbol (assoc
3159                 (symbol-name (car (gnus-find-method-for-group group)))
3160                 gnus-valid-select-methods)))
3161
3162 (defun gnus-method-option-p (method option)
3163   "Return non-nil if select METHOD has OPTION as a parameter."
3164   (when (stringp method)
3165     (setq method (gnus-server-to-method method)))
3166   (memq option (assoc (format "%s" (car method))
3167                       gnus-valid-select-methods)))
3168
3169 (defun gnus-similar-server-opened (method)
3170   (let ((opened gnus-opened-servers))
3171     (while (and method opened)
3172       (when (and (equal (cadr method) (cadaar opened))
3173                  (equal (car method) (caaar opened))
3174                  (not (equal method (caar opened))))
3175         (setq method nil))
3176       (pop opened))
3177     (not method)))
3178
3179 (defun gnus-server-extend-method (group method)
3180   ;; This function "extends" a virtual server.  If the server is
3181   ;; "hello", and the select method is ("hello" (my-var "something"))
3182   ;; in the group "alt.alt", this will result in a new virtual server
3183   ;; called "hello+alt.alt".
3184   (if (or (not (inline (gnus-similar-server-opened method)))
3185           (not (cddr method)))
3186       method
3187     `(,(car method) ,(concat (cadr method) "+" group)
3188       (,(intern (format "%s-address" (car method))) ,(cadr method))
3189       ,@(cddr method))))
3190
3191 (defun gnus-server-status (method)
3192   "Return the status of METHOD."
3193   (nth 1 (assoc method gnus-opened-servers)))
3194
3195 (defun gnus-group-name-to-method (group)
3196   "Guess a select method based on GROUP."
3197   (if (string-match ":" group)
3198       (let ((server (substring group 0 (match-beginning 0))))
3199         (if (string-match "\\+" server)
3200             (list (intern (substring server 0 (match-beginning 0)))
3201                   (substring server (match-end 0)))
3202           (list (intern server) "")))
3203     gnus-select-method))
3204
3205 (defun gnus-server-string (server)
3206   "Return a readable string that describes SERVER."
3207   (let* ((server (gnus-server-to-method server))
3208          (address (nth 1 server)))
3209     (if (and address
3210              (not (zerop (length address))))
3211         (format "%s using %s" address (car server))
3212       (format "%s" (car server)))))
3213
3214 (defun gnus-find-method-for-group (group &optional info)
3215   "Find the select method that GROUP uses."
3216   (or gnus-override-method
3217       (and (not group)
3218            gnus-select-method)
3219       (and (not (gnus-group-entry group)) ;; a new group
3220            (gnus-group-name-to-method group))
3221       (let ((info (or info (gnus-get-info group)))
3222             method)
3223         (if (or (not info)
3224                 (not (setq method (gnus-info-method info)))
3225                 (equal method "native"))
3226             gnus-select-method
3227           (setq method
3228                 (cond ((stringp method)
3229                        (inline (gnus-server-to-method method)))
3230                       ((stringp (cadr method))
3231                        (inline (gnus-server-extend-method group method)))
3232                       (t
3233                        method)))
3234           (cond ((equal (cadr method) "")
3235                  method)
3236                 ((null (cadr method))
3237                  (list (car method) ""))
3238                 (t
3239                  (gnus-server-add-address method)))))))
3240
3241 (defun gnus-methods-using (feature)
3242   "Find all methods that have FEATURE."
3243   (let ((valids gnus-valid-select-methods)
3244         outs)
3245     (while valids
3246       (when (memq feature (car valids))
3247         (push (car valids) outs))
3248       (setq valids (cdr valids)))
3249     outs))
3250
3251 (defun gnus-read-group (prompt &optional default)
3252   "Prompt the user for a group name.
3253 Disallow invalid group names."
3254   (let ((prefix "")
3255         group)
3256     (while (not group)
3257       (when (string-match
3258              gnus-invalid-group-regexp
3259              (setq group (read-string (concat prefix prompt)
3260                                       (cons (or default "") 0)
3261                                       'gnus-group-history)))
3262         (setq prefix (format "Invalid group name: \"%s\".  " group)
3263               group nil)))
3264     group))
3265
3266 (defun gnus-read-method (prompt)
3267   "Prompt the user for a method.
3268 Allow completion over sensible values."
3269   (let* ((open-servers
3270           (mapcar (lambda (i) (cons (format "%s:%s" (caar i) (cadar i)) i))
3271                   gnus-opened-servers))
3272          (valid-methods
3273           (let (methods)
3274             (dolist (method gnus-valid-select-methods)
3275               (if (or (memq 'prompt-address method)
3276                       (not (assoc (format "%s:" (car method)) open-servers)))
3277                   (push method methods)))
3278             methods))
3279          (servers
3280           (append valid-methods
3281                   open-servers
3282                   gnus-predefined-server-alist
3283                   gnus-server-alist))
3284          (method
3285           (completing-read
3286            prompt servers
3287            nil t nil 'gnus-method-history)))
3288     (cond
3289      ((equal method "")
3290       (setq method gnus-select-method))
3291      ((assoc method gnus-valid-select-methods)
3292       (let ((address (if (memq 'prompt-address
3293                                (assoc method gnus-valid-select-methods))
3294                          (read-string "Address: ")
3295                        "")))
3296         (or (cadr (assoc (format "%s:%s" method address) open-servers))
3297             (list (intern method) address))))
3298      ((assoc method servers)
3299       method)
3300      (t
3301       (list (intern method) "")))))
3302
3303 ;;; Agent functions
3304
3305 (defun gnus-agent-method-p (method)
3306   "Say whether METHOD is covered by the agent."
3307   (member method gnus-agent-covered-methods))
3308
3309 (defun gnus-online (method)
3310   (not
3311    (if gnus-plugged
3312        (eq (cadr (assoc method gnus-opened-servers)) 'offline)
3313      (gnus-agent-method-p method))))
3314
3315 ;;; User-level commands.
3316
3317 ;;;###autoload
3318 (defun gnus-slave-no-server (&optional arg)
3319   "Read network news as a slave, without connecting to the local server."
3320   (interactive "P")
3321   (gnus-no-server arg t))
3322
3323 ;;;###autoload
3324 (defun gnus-no-server (&optional arg slave)
3325   "Read network news.
3326 If ARG is a positive number, Gnus will use that as the startup
3327 level. If ARG is nil, Gnus will be started at level 2.  If ARG is
3328 non-nil and not a positive number, Gnus will prompt the user for the
3329 name of an NNTP server to use.
3330 As opposed to `gnus', this command will not connect to the local
3331 server."
3332   (interactive "P")
3333   (gnus-no-server-1 arg slave))
3334
3335 ;;;###autoload
3336 (defun gnus-slave (&optional arg)
3337   "Read news as a slave."
3338   (interactive "P")
3339   (gnus arg nil 'slave))
3340
3341 ;;;###autoload
3342 (defun gnus-other-frame (&optional arg)
3343   "Pop up a frame to read news."
3344   (interactive "P")
3345   (let ((window (get-buffer-window gnus-group-buffer)))
3346     (cond (window
3347            (select-frame (window-frame window)))
3348           (t
3349            (select-frame (make-frame)))))
3350   (gnus arg))
3351
3352 ;;(setq thing ?                         ; this is a comment
3353 ;;      more 'yes)
3354
3355 ;;;###autoload
3356 (defun gnus (&optional arg dont-connect slave)
3357   "Read network news.
3358 If ARG is non-nil and a positive number, Gnus will use that as the
3359 startup level.  If ARG is non-nil and not a positive number, Gnus will
3360 prompt the user for the name of an NNTP server to use."
3361   (interactive "P")
3362   (unless (byte-code-function-p (symbol-function 'gnus))
3363     (message "You should byte-compile Gnus")
3364     (sit-for 2))
3365   (gnus-1 arg dont-connect slave))
3366
3367 ;; Allow redefinition of Gnus functions.
3368
3369 (gnus-ems-redefine)
3370
3371 (provide 'gnus)
3372
3373 ;;; gnus.el ends here