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