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