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