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