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