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