Make Gnus work for Emacs 22 and XEmacs.
[gnus] / lisp / gnus-sum.el
1 ;;; gnus-sum.el --- summary mode commands for Gnus
2
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
4 ;;   2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
5
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 ;; For Emacs < 22.2.
29 (eval-and-compile
30   (unless (fboundp 'declare-function) (defmacro declare-function (&rest r))))
31 (eval-when-compile
32   (require 'cl))
33 (eval-when-compile
34   (when (featurep 'xemacs)
35     (require 'easy-mmode))) ; for `define-minor-mode'
36
37 (defvar tool-bar-mode)
38 (defvar gnus-tmp-header)
39
40 (require 'gnus)
41 (require 'gnus-group)
42 (require 'gnus-spec)
43 (require 'gnus-range)
44 (require 'gnus-int)
45 (require 'gnus-undo)
46 (require 'gnus-util)
47 (require 'gmm-utils)
48 (require 'mm-decode)
49 (require 'nnoo)
50
51 (autoload 'gnus-summary-limit-include-cached "gnus-cache" nil t)
52 (autoload 'gnus-cache-write-active "gnus-cache")
53 (autoload 'gnus-mailing-list-insinuate "gnus-ml" nil t)
54 (autoload 'turn-on-gnus-mailing-list-mode "gnus-ml" nil t)
55 (autoload 'gnus-pick-line-number "gnus-salt" nil t)
56 (autoload 'mm-uu-dissect "mm-uu")
57 (autoload 'gnus-article-outlook-deuglify-article "deuglify"
58   "Deuglify broken Outlook (Express) articles and redisplay."
59   t)
60 (autoload 'gnus-article-outlook-unwrap-lines "deuglify" nil t)
61 (autoload 'gnus-article-outlook-repair-attribution "deuglify" nil t)
62 (autoload 'gnus-article-outlook-rearrange-citation "deuglify" nil t)
63
64 (defcustom gnus-kill-summary-on-exit t
65   "*If non-nil, kill the summary buffer when you exit from it.
66 If nil, the summary will become a \"*Dead Summary*\" buffer, and
67 it will be killed sometime later."
68   :group 'gnus-summary-exit
69   :type 'boolean)
70
71 (defcustom gnus-summary-next-group-on-exit t
72   "If non-nil, go to the next unread newsgroup on summary exit.
73 See `gnus-group-goto-unread'."
74   :link '(custom-manual "(gnus)Group Maneuvering")
75   :group 'gnus-summary-exit
76   :version "23.1" ;; No Gnus
77   :type 'boolean)
78
79 (defcustom gnus-summary-stop-at-end-of-message nil
80   "If non-nil, don't select the next message when using `SPC'."
81   :link '(custom-manual "(gnus)Group Maneuvering")
82   :group 'gnus-summary-maneuvering
83   :version "24.1"
84   :type 'boolean)
85
86 (defcustom gnus-fetch-old-headers nil
87   "*Non-nil means that Gnus will try to build threads by grabbing old headers.
88 If an unread article in the group refers to an older, already
89 read (or just marked as read) article, the old article will not
90 normally be displayed in the Summary buffer.  If this variable is
91 t, Gnus will attempt to grab the headers to the old articles, and
92 thereby build complete threads.  If it has the value `some', all
93 old headers will be fetched but only enough headers to connect
94 otherwise loose threads will be displayed.  This variable can
95 also be a number.  In that case, no more than that number of old
96 headers will be fetched.  If it has the value `invisible', all
97 old headers will be fetched, but none will be displayed.
98
99 The server has to support NOV for any of this to work.
100
101 This feature can seriously impact performance it ignores all
102 locally cached header entries.  Setting it to t for groups for a
103 server that doesn't expire articles (such as news.gmane.org),
104 leads to very slow summary generation."
105   :group 'gnus-thread
106   :type '(choice (const :tag "off" nil)
107                  (const :tag "on" t)
108                  (const some)
109                  (const invisible)
110                  number
111                  (sexp :menu-tag "other" t)))
112
113 (defcustom gnus-refer-thread-limit 500
114   "*The number of old headers to fetch when doing \\<gnus-summary-mode-map>\\[gnus-summary-refer-thread].
115 If t, fetch all the available old headers."
116   :group 'gnus-thread
117   :type '(choice number
118                  (sexp :menu-tag "other" t)))
119
120 (defcustom gnus-summary-make-false-root 'adopt
121   "*nil means that Gnus won't gather loose threads.
122 If the root of a thread has expired or been read in a previous
123 session, the information necessary to build a complete thread has been
124 lost.  Instead of having many small sub-threads from this original thread
125 scattered all over the summary buffer, Gnus can gather them.
126
127 If non-nil, Gnus will try to gather all loose sub-threads from an
128 original thread into one large thread.
129
130 If this variable is non-nil, it should be one of `none', `adopt',
131 `dummy' or `empty'.
132
133 If this variable is `none', Gnus will not make a false root, but just
134 present the sub-threads after another.
135 If this variable is `dummy', Gnus will create a dummy root that will
136 have all the sub-threads as children.
137 If this variable is `adopt', Gnus will make one of the \"children\"
138 the parent and mark all the step-children as such.
139 If this variable is `empty', the \"children\" are printed with empty
140 subject fields.  (Or rather, they will be printed with a string
141 given by the `gnus-summary-same-subject' variable.)"
142   :group 'gnus-thread
143   :type '(choice (const :tag "off" nil)
144                  (const none)
145                  (const dummy)
146                  (const adopt)
147                  (const empty)))
148
149 (defcustom gnus-summary-make-false-root-always nil
150   "Always make a false dummy root."
151   :version "22.1"
152   :group 'gnus-thread
153   :type 'boolean)
154
155 (defcustom gnus-summary-gather-exclude-subject "^ *$\\|^(none)$"
156   "*A regexp to match subjects to be excluded from loose thread gathering.
157 As loose thread gathering is done on subjects only, that means that
158 there can be many false gatherings performed.  By rooting out certain
159 common subjects, gathering might become saner."
160   :group 'gnus-thread
161   :type 'regexp)
162
163 (defcustom gnus-summary-gather-subject-limit nil
164   "*Maximum length of subject comparisons when gathering loose threads.
165 Use nil to compare full subjects.  Setting this variable to a low
166 number will help gather threads that have been corrupted by
167 newsreaders chopping off subject lines, but it might also mean that
168 unrelated articles that have subject that happen to begin with the
169 same few characters will be incorrectly gathered.
170
171 If this variable is `fuzzy', Gnus will use a fuzzy algorithm when
172 comparing subjects."
173   :group 'gnus-thread
174   :type '(choice (const :tag "off" nil)
175                  (const fuzzy)
176                  (sexp :menu-tag "on" t)))
177
178 (defcustom gnus-simplify-subject-functions nil
179   "List of functions taking a string argument that simplify subjects.
180 The functions are applied recursively.
181
182 Useful functions to put in this list include:
183 `gnus-simplify-subject-re', `gnus-simplify-subject-fuzzy',
184 `gnus-simplify-whitespace', and `gnus-simplify-all-whitespace'."
185   :group 'gnus-thread
186   :type '(repeat function))
187
188 (defcustom gnus-simplify-ignored-prefixes nil
189   "*Remove matches for this regexp from subject lines when simplifying fuzzily."
190   :group 'gnus-thread
191   :type '(choice (const :tag "off" nil)
192                  regexp))
193
194 (defcustom gnus-build-sparse-threads nil
195   "*If non-nil, fill in the gaps in threads.
196 If `some', only fill in the gaps that are needed to tie loose threads
197 together.  If `more', fill in all leaf nodes that Gnus can find.  If
198 non-nil and non-`some', fill in all gaps that Gnus manages to guess."
199   :group 'gnus-thread
200   :type '(choice (const :tag "off" nil)
201                  (const some)
202                  (const more)
203                  (sexp :menu-tag "all" t)))
204
205 (defcustom gnus-summary-thread-gathering-function
206   'gnus-gather-threads-by-subject
207   "*Function used for gathering loose threads.
208 There are two pre-defined functions: `gnus-gather-threads-by-subject',
209 which only takes Subjects into consideration; and
210 `gnus-gather-threads-by-references', which compared the References
211 headers of the articles to find matches."
212   :group 'gnus-thread
213   :type '(radio (function-item gnus-gather-threads-by-subject)
214                 (function-item gnus-gather-threads-by-references)
215                 (function :tag "other")))
216
217 (defcustom gnus-summary-same-subject ""
218   "*String indicating that the current article has the same subject as the previous.
219 This variable will only be used if the value of
220 `gnus-summary-make-false-root' is `empty'."
221   :group 'gnus-summary-format
222   :type 'string)
223
224 (defcustom gnus-summary-goto-unread nil
225   "*If t, many commands will go to the next unread article.
226 This applies to marking commands as well as other commands that
227 \"naturally\" select the next article, like, for instance, `SPC' at
228 the end of an article.
229
230 If nil, the marking commands do NOT go to the next unread article
231 \(they go to the next article instead).  If `never', commands that
232 usually go to the next unread article, will go to the next article,
233 whether it is read or not."
234   :version "24.1"
235   :group 'gnus-summary-marks
236   :link '(custom-manual "(gnus)Setting Marks")
237   :type '(choice (const :tag "off" nil)
238                  (const never)
239                  (sexp :menu-tag "on" t)))
240
241 (defcustom gnus-summary-default-score 0
242   "*Default article score level.
243 All scores generated by the score files will be added to this score.
244 If this variable is nil, scoring will be disabled."
245   :group 'gnus-score-default
246   :type '(choice (const :tag "disable")
247                  integer))
248
249 (defcustom gnus-summary-default-high-score 0
250   "*Default threshold for a high scored article.
251 An article will be highlighted as high scored if its score is greater
252 than this score."
253   :version "22.1"
254   :group 'gnus-score-default
255   :type 'integer)
256
257 (defcustom gnus-summary-default-low-score 0
258   "*Default threshold for a low scored article.
259 An article will be highlighted as low scored if its score is smaller
260 than this score."
261   :version "22.1"
262   :group 'gnus-score-default
263   :type 'integer)
264
265 (defcustom gnus-summary-zcore-fuzz 0
266   "*Fuzziness factor for the zcore in the summary buffer.
267 Articles with scores closer than this to `gnus-summary-default-score'
268 will not be marked."
269   :group 'gnus-summary-format
270   :type 'integer)
271
272 (defcustom gnus-simplify-subject-fuzzy-regexp nil
273   "*Strings to be removed when doing fuzzy matches.
274 This can either be a regular expression or list of regular expressions
275 that will be removed from subject strings if fuzzy subject
276 simplification is selected."
277   :group 'gnus-thread
278   :type '(repeat regexp))
279
280 (defcustom gnus-show-threads t
281   "*If non-nil, display threads in summary mode."
282   :group 'gnus-thread
283   :type 'boolean)
284
285 (defcustom gnus-thread-hide-subtree nil
286   "*If non-nil, hide all threads initially.
287 This can be a predicate specifier which says which threads to hide.
288 If threads are hidden, you have to run the command
289 `gnus-summary-show-thread' by hand or select an article."
290   :group 'gnus-thread
291   :type '(radio (sexp :format "Non-nil\n"
292                       :match (lambda (widget value)
293                                (not (or (consp value) (functionp value))))
294                       :value t)
295                 (const nil)
296                 (sexp :tag "Predicate specifier")))
297
298 (defcustom gnus-thread-hide-killed t
299   "*If non-nil, hide killed threads automatically."
300   :group 'gnus-thread
301   :type 'boolean)
302
303 (defcustom gnus-thread-ignore-subject t
304   "*If non-nil, which is the default, ignore subjects and do all threading based on the Reference header.
305 If nil, articles that have different subjects from their parents will
306 start separate threads."
307   :group 'gnus-thread
308   :type 'boolean)
309
310 (defcustom gnus-thread-operation-ignore-subject t
311   "*If non-nil, subjects will be ignored when doing thread commands.
312 This affects commands like `gnus-summary-kill-thread' and
313 `gnus-summary-lower-thread'.
314
315 If this variable is nil, articles in the same thread with different
316 subjects will not be included in the operation in question.  If this
317 variable is `fuzzy', only articles that have subjects that are fuzzily
318 equal will be included."
319   :group 'gnus-thread
320   :type '(choice (const :tag "off" nil)
321                  (const fuzzy)
322                  (sexp :tag "on" t)))
323
324 (defcustom gnus-thread-indent-level 4
325   "*Number that says how much each sub-thread should be indented."
326   :group 'gnus-thread
327   :type 'integer)
328
329 (defcustom gnus-auto-extend-newsgroup t
330   "*If non-nil, extend newsgroup forward and backward when requested."
331   :group 'gnus-summary-choose
332   :type 'boolean)
333
334 (defcustom gnus-auto-select-first t
335   "If non-nil, select an article on group entry.
336 An article is selected automatically when entering a group
337 e.g. with \\<gnus-group-mode-map>\\[gnus-group-read-group], or via `gnus-summary-next-page' or
338 `gnus-summary-catchup-and-goto-next-group'.
339
340 Which article is selected is controlled by the variable
341 `gnus-auto-select-subject'.
342
343 If you want to prevent automatic selection of articles in some
344 newsgroups, set the variable to nil in `gnus-select-group-hook'."
345   ;; Commands include...
346   ;; \\<gnus-group-mode-map>\\[gnus-group-read-group]
347   ;; \\<gnus-summary-mode-map>\\[gnus-summary-next-page]
348   ;; \\<gnus-summary-mode-map>\\[gnus-summary-catchup-and-goto-next-group]
349   :group 'gnus-group-select
350   :type '(choice (const :tag "none" nil)
351                  (sexp :menu-tag "first" t)))
352
353 (defcustom gnus-auto-select-subject 'unseen-or-unread
354   "*Says what subject to place under point when entering a group.
355
356 This variable can either be the symbols `first' (place point on the
357 first subject), `unread' (place point on the subject line of the first
358 unread article), `best' (place point on the subject line of the
359 higest-scored article), `unseen' (place point on the subject line of
360 the first unseen article), `unseen-or-unread' (place point on the subject
361 line of the first unseen article or, if all article have been seen, on the
362 subject line of the first unread article), or a function to be called to
363 place point on some subject line."
364   :version "24.1"
365   :group 'gnus-group-select
366   :type '(choice (const best)
367                  (const unread)
368                  (const first)
369                  (const unseen)
370                  (const unseen-or-unread)))
371
372 (defcustom gnus-auto-select-next t
373   "*If non-nil, offer to go to the next group from the end of the previous.
374 If the value is t and the next newsgroup is empty, Gnus will exit
375 summary mode and go back to group mode.  If the value is neither nil
376 nor t, Gnus will select the following unread newsgroup.  In
377 particular, if the value is the symbol `quietly', the next unread
378 newsgroup will be selected without any confirmation, and if it is
379 `almost-quietly', the next group will be selected without any
380 confirmation if you are located on the last article in the group.
381 Finally, if this variable is `slightly-quietly', the `\\<gnus-summary-mode-map>\\[gnus-summary-catchup-and-goto-next-group]' command
382 will go to the next group without confirmation."
383   :group 'gnus-summary-maneuvering
384   :type '(choice (const :tag "off" nil)
385                  (const quietly)
386                  (const almost-quietly)
387                  (const slightly-quietly)
388                  (sexp :menu-tag "on" t)))
389
390 (defcustom gnus-auto-select-same nil
391   "*If non-nil, select the next article with the same subject.
392 If there are no more articles with the same subject, go to
393 the first unread article."
394   :group 'gnus-summary-maneuvering
395   :type 'boolean)
396
397 (defcustom gnus-auto-select-on-ephemeral-exit 'next-noselect
398   "What article should be selected after exiting an ephemeral group.
399 Valid values include:
400
401 `next'
402   Select the next article.
403 `next-unread'
404   Select the next unread article.
405 `next-noselect'
406   Move the cursor to the next article.  This is the default.
407 `next-unread-noselect'
408   Move the cursor to the next unread article.
409
410 If it has any other value or there is no next (unread) article, the
411 article selected before entering to the ephemeral group will appear."
412   :version "23.1" ;; No Gnus
413   :group 'gnus-summary-maneuvering
414   :type '(choice :format "%{%t%}:\n %[Value Menu%] %v"
415                  (const next) (const next-unread)
416                  (const next-noselect) (const next-unread-noselect)
417                  (sexp :tag "other" :value nil)))
418
419 (defcustom gnus-auto-goto-ignores 'unfetched
420   "*Says how to handle unfetched articles when maneuvering.
421
422 This variable can either be the symbols nil (maneuver to any
423 article), `undownloaded' (maneuvering while unplugged ignores articles
424 that have not been fetched), `always-undownloaded' (maneuvering always
425 ignores articles that have not been fetched), `unfetched' (maneuvering
426 ignores articles whose headers have not been fetched).
427
428 NOTE: The list of unfetched articles will always be nil when plugged
429 and, when unplugged, a subset of the undownloaded article list."
430   :version "22.1"
431   :group 'gnus-summary-maneuvering
432   :type '(choice (const :tag "None" nil)
433                  (const :tag "Undownloaded when unplugged" undownloaded)
434                  (const :tag "Undownloaded" always-undownloaded)
435                  (const :tag "Unfetched" unfetched)))
436
437 (defcustom gnus-summary-check-current nil
438   "*If non-nil, consider the current article when moving.
439 The \"unread\" movement commands will stay on the same line if the
440 current article is unread."
441   :group 'gnus-summary-maneuvering
442   :type 'boolean)
443
444 (defcustom gnus-auto-center-summary 2
445   "*If non-nil, always center the current summary buffer.
446 In particular, if `vertical' do only vertical recentering.  If non-nil
447 and non-`vertical', do both horizontal and vertical recentering."
448   :group 'gnus-summary-maneuvering
449   :type '(choice (const :tag "none" nil)
450                  (const vertical)
451                  (integer :tag "height")
452                  (sexp :menu-tag "both" t)))
453
454 (defvar gnus-auto-center-group t
455   "*If non-nil, always center the group buffer.")
456
457 (defcustom gnus-show-all-headers nil
458   "*If non-nil, don't hide any headers."
459   :group 'gnus-article-hiding
460   :group 'gnus-article-headers
461   :type 'boolean)
462
463 (defcustom gnus-summary-ignore-duplicates nil
464   "*If non-nil, ignore articles with identical Message-ID headers."
465   :group 'gnus-summary
466   :type 'boolean)
467
468 (defcustom gnus-single-article-buffer nil
469   "*If non-nil, display all articles in the same buffer.
470 If nil, each group will get its own article buffer."
471   :version "24.1"
472   :group 'gnus-article-various
473   :type 'boolean)
474
475 (defcustom gnus-break-pages t
476   "*If non-nil, do page breaking on articles.
477 The page delimiter is specified by the `gnus-page-delimiter'
478 variable."
479   :group 'gnus-article-various
480   :type 'boolean)
481
482 (defcustom gnus-move-split-methods nil
483   "*Variable used to suggest where articles are to be moved to.
484 It uses the same syntax as the `gnus-split-methods' variable.
485 However, whereas `gnus-split-methods' specifies file names as targets,
486 this variable specifies group names."
487   :group 'gnus-summary-mail
488   :type '(repeat (choice (list :value (fun) function)
489                          (cons :value ("" "") regexp (repeat string))
490                          (sexp :value nil))))
491
492 (defcustom gnus-move-group-prefix-function 'gnus-group-real-prefix
493   "Function used to compute default prefix for article move/copy/etc prompts.
494 The function should take one argument, a group name, and return a
495 string with the suggested prefix."
496   :group 'gnus-summary-mail
497   :type 'function)
498
499 ;; FIXME: Although the custom type is `character' for the following variables,
500 ;; using multibyte characters (Latin-1, UTF-8) doesn't work.  -- rs
501
502 (defcustom gnus-unread-mark ?           ;Whitespace
503   "*Mark used for unread articles."
504   :group 'gnus-summary-marks
505   :type 'character)
506
507 (defcustom gnus-ticked-mark ?!
508   "*Mark used for ticked articles."
509   :group 'gnus-summary-marks
510   :type 'character)
511
512 (defcustom gnus-dormant-mark ??
513   "*Mark used for dormant articles."
514   :group 'gnus-summary-marks
515   :type 'character)
516
517 (defcustom gnus-del-mark ?r
518   "*Mark used for del'd articles."
519   :group 'gnus-summary-marks
520   :type 'character)
521
522 (defcustom gnus-read-mark ?R
523   "*Mark used for read articles."
524   :group 'gnus-summary-marks
525   :type 'character)
526
527 (defcustom gnus-expirable-mark ?E
528   "*Mark used for expirable articles."
529   :group 'gnus-summary-marks
530   :type 'character)
531
532 (defcustom gnus-killed-mark ?K
533   "*Mark used for killed articles."
534   :group 'gnus-summary-marks
535   :type 'character)
536
537 (defcustom gnus-spam-mark ?$
538   "*Mark used for spam articles."
539   :version "22.1"
540   :group 'gnus-summary-marks
541   :type 'character)
542
543 (defcustom gnus-kill-file-mark ?X
544   "*Mark used for articles killed by kill files."
545   :group 'gnus-summary-marks
546   :type 'character)
547
548 (defcustom gnus-low-score-mark ?Y
549   "*Mark used for articles with a low score."
550   :group 'gnus-summary-marks
551   :type 'character)
552
553 (defcustom gnus-catchup-mark ?C
554   "*Mark used for articles that are caught up."
555   :group 'gnus-summary-marks
556   :type 'character)
557
558 (defcustom gnus-replied-mark ?A
559   "*Mark used for articles that have been replied to."
560   :group 'gnus-summary-marks
561   :type 'character)
562
563 (defcustom gnus-forwarded-mark ?F
564   "*Mark used for articles that have been forwarded."
565   :version "22.1"
566   :group 'gnus-summary-marks
567   :type 'character)
568
569 (defcustom gnus-recent-mark ?N
570   "*Mark used for articles that are recent."
571   :version "22.1"
572   :group 'gnus-summary-marks
573   :type 'character)
574
575 (defcustom gnus-cached-mark ?*
576   "*Mark used for articles that are in the cache."
577   :group 'gnus-summary-marks
578   :type 'character)
579
580 (defcustom gnus-saved-mark ?S
581   "*Mark used for articles that have been saved."
582   :group 'gnus-summary-marks
583   :type 'character)
584
585 (defcustom gnus-unseen-mark ?.
586   "*Mark used for articles that haven't been seen."
587   :version "22.1"
588   :group 'gnus-summary-marks
589   :type 'character)
590
591 (defcustom gnus-no-mark ?               ;Whitespace
592   "*Mark used for articles that have no other secondary mark."
593   :version "22.1"
594   :group 'gnus-summary-marks
595   :type 'character)
596
597 (defcustom gnus-ancient-mark ?O
598   "*Mark used for ancient articles."
599   :group 'gnus-summary-marks
600   :type 'character)
601
602 (defcustom gnus-sparse-mark ?Q
603   "*Mark used for sparsely reffed articles."
604   :group 'gnus-summary-marks
605   :type 'character)
606
607 (defcustom gnus-canceled-mark ?G
608   "*Mark used for canceled articles."
609   :group 'gnus-summary-marks
610   :type 'character)
611
612 (defcustom gnus-duplicate-mark ?M
613   "*Mark used for duplicate articles."
614   :group 'gnus-summary-marks
615   :type 'character)
616
617 (defcustom gnus-undownloaded-mark ?-
618   "*Mark used for articles that weren't downloaded."
619   :version "22.1"
620   :group 'gnus-summary-marks
621   :type 'character)
622
623 (defcustom gnus-downloaded-mark ?+
624   "*Mark used for articles that were downloaded."
625   :group 'gnus-summary-marks
626   :type 'character)
627
628 (defcustom gnus-downloadable-mark ?%
629   "*Mark used for articles that are to be downloaded."
630   :group 'gnus-summary-marks
631   :type 'character)
632
633 (defcustom gnus-unsendable-mark ?=
634   "*Mark used for articles that won't be sent."
635   :group 'gnus-summary-marks
636   :type 'character)
637
638 (defcustom gnus-score-over-mark ?+
639   "*Score mark used for articles with high scores."
640   :group 'gnus-summary-marks
641   :type 'character)
642
643 (defcustom gnus-score-below-mark ?-
644   "*Score mark used for articles with low scores."
645   :group 'gnus-summary-marks
646   :type 'character)
647
648 (defcustom gnus-empty-thread-mark ?     ;Whitespace
649   "*There is no thread under the article."
650   :group 'gnus-summary-marks
651   :type 'character)
652
653 (defcustom gnus-not-empty-thread-mark ?=
654   "*There is a thread under the article."
655   :group 'gnus-summary-marks
656   :type 'character)
657
658 (defcustom gnus-view-pseudo-asynchronously nil
659   "*If non-nil, Gnus will view pseudo-articles asynchronously."
660   :group 'gnus-extract-view
661   :type 'boolean)
662
663 (defcustom gnus-auto-expirable-marks
664   (list gnus-killed-mark gnus-del-mark gnus-catchup-mark
665         gnus-low-score-mark gnus-ancient-mark gnus-read-mark
666         gnus-duplicate-mark)
667   "*The list of marks converted into expiration if a group is auto-expirable."
668   :version "24.1"
669   :group 'gnus-summary
670   :type '(repeat character))
671
672 (defcustom gnus-inhibit-user-auto-expire t
673   "*If non-nil, user marking commands will not mark an article as expirable, even if the group has auto-expire turned on."
674   :version "21.1"
675   :group 'gnus-summary
676   :type 'boolean)
677
678 (defcustom gnus-mark-copied-or-moved-articles-as-expirable nil
679   "If non-nil, mark articles copied or moved to auto-expire group as expirable.
680 If nil, the expirable marks will be unchanged except that the marks
681 will be removed when copying or moving articles to a group that has
682 not turned auto-expire on.  If non-nil, articles that have been read
683 will be marked as expirable when being copied or moved to a group in
684 which auto-expire is turned on."
685   :version "23.2"
686   :type 'boolean
687   :group 'gnus-summary-marks)
688
689 (defcustom gnus-view-pseudos nil
690   "*If `automatic', pseudo-articles will be viewed automatically.
691 If `not-confirm', pseudos will be viewed automatically, and the user
692 will not be asked to confirm the command."
693   :group 'gnus-extract-view
694   :type '(choice (const :tag "off" nil)
695                  (const automatic)
696                  (const not-confirm)))
697
698 (defcustom gnus-view-pseudos-separately t
699   "*If non-nil, one pseudo-article will be created for each file to be viewed.
700 If nil, all files that use the same viewing command will be given as a
701 list of parameters to that command."
702   :group 'gnus-extract-view
703   :type 'boolean)
704
705 (defcustom gnus-insert-pseudo-articles t
706   "*If non-nil, insert pseudo-articles when decoding articles."
707   :group 'gnus-extract-view
708   :type 'boolean)
709
710 (defcustom gnus-summary-dummy-line-format
711   "   %(:                             :%) %S\n"
712   "*The format specification for the dummy roots in the summary buffer.
713 It works along the same lines as a normal formatting string,
714 with some simple extensions.
715
716 %S  The subject
717
718 General format specifiers can also be used.
719 See `(gnus)Formatting Variables'."
720   :link '(custom-manual "(gnus)Formatting Variables")
721   :group 'gnus-threading
722   :type 'string)
723
724 (defcustom gnus-summary-mode-line-format "Gnus: %g [%A] %Z"
725   "*The format specification for the summary mode line.
726 It works along the same lines as a normal formatting string,
727 with some simple extensions:
728
729 %G  Group name
730 %p  Unprefixed group name
731 %A  Current article number
732 %z  Current article score
733 %V  Gnus version
734 %U  Number of unread articles in the group
735 %e  Number of unselected articles in the group
736 %Z  A string with unread/unselected article counts
737 %g  Shortish group name
738 %S  Subject of the current article
739 %u  User-defined spec
740 %s  Current score file name
741 %d  Number of dormant articles
742 %r  Number of articles that have been marked as read in this session
743 %E  Number of articles expunged by the score files"
744   :group 'gnus-summary-format
745   :type 'string)
746
747 (defcustom gnus-list-identifiers nil
748   "Regexp that matches list identifiers to be removed from subject.
749 This can also be a list of regexps."
750   :version "21.1"
751   :group 'gnus-summary-format
752   :group 'gnus-article-hiding
753   :type '(choice (const :tag "none" nil)
754                  (regexp :value ".*")
755                  (repeat :value (".*") regexp)))
756
757 (defcustom gnus-summary-mark-below 0
758   "*Mark all articles with a score below this variable as read.
759 This variable is local to each summary buffer and usually set by the
760 score file."
761   :group 'gnus-score-default
762   :type 'integer)
763
764 (defun gnus-widget-reversible-match (widget value)
765   "Ignoring WIDGET, convert VALUE to internal form.
766 VALUE should have the form `FOO' or `(not FOO)', where FOO is an symbol."
767   ;; (debug value)
768   (or (symbolp value)
769       (and (listp value)
770            (eq (length value) 2)
771            (eq (nth 0 value) 'not)
772            (symbolp (nth 1 value)))))
773
774 (defun gnus-widget-reversible-to-internal (widget value)
775   "Ignoring WIDGET, convert VALUE to internal form.
776 VALUE should have the form `FOO' or `(not FOO)', where FOO is an atom.
777 FOO is converted to (FOO nil) and (not FOO) is converted to (FOO t)."
778   ;; (debug value)
779   (if (atom value)
780       (list value nil)
781     (list (nth 1 value) t)))
782
783 (defun gnus-widget-reversible-to-external (widget value)
784   "Ignoring WIDGET, convert VALUE to external form.
785 VALUE should have the form `(FOO nil)' or `(FOO t)', where FOO is an atom.
786 \(FOO  nil) is converted to FOO and (FOO t) is converted to (not FOO)."
787   ;; (debug value)
788   (if (nth 1 value)
789       (list 'not (nth 0 value))
790     (nth 0 value)))
791
792 (define-widget 'gnus-widget-reversible 'group
793   "A `group' that convert values."
794   :match 'gnus-widget-reversible-match
795   :value-to-internal 'gnus-widget-reversible-to-internal
796   :value-to-external 'gnus-widget-reversible-to-external)
797
798 (defcustom gnus-article-sort-functions '(gnus-article-sort-by-number)
799   "*List of functions used for sorting articles in the summary buffer.
800
801 Each function takes two articles and returns non-nil if the first
802 article should be sorted before the other.  If you use more than one
803 function, the primary sort function should be the last.  You should
804 probably always include `gnus-article-sort-by-number' in the list of
805 sorting functions -- preferably first.  Also note that sorting by date
806 is often much slower than sorting by number, and the sorting order is
807 very similar.  (Sorting by date means sorting by the time the message
808 was sent, sorting by number means sorting by arrival time.)
809
810 Each item can also be a list `(not F)' where F is a function;
811 this reverses the sort order.
812
813 Ready-made functions include `gnus-article-sort-by-number',
814 `gnus-article-sort-by-author', `gnus-article-sort-by-subject',
815 `gnus-article-sort-by-date', `gnus-article-sort-by-random'
816 and `gnus-article-sort-by-score'.
817
818 When threading is turned on, the variable `gnus-thread-sort-functions'
819 controls how articles are sorted."
820   :group 'gnus-summary-sort
821   :type '(repeat (gnus-widget-reversible
822                   (choice (function-item gnus-article-sort-by-number)
823                           (function-item gnus-article-sort-by-author)
824                           (function-item gnus-article-sort-by-subject)
825                           (function-item gnus-article-sort-by-date)
826                           (function-item gnus-article-sort-by-score)
827                           (function-item gnus-article-sort-by-random)
828                           (function :tag "other"))
829                   (boolean :tag "Reverse order"))))
830
831
832 (defcustom gnus-thread-sort-functions '(gnus-thread-sort-by-number)
833   "*List of functions used for sorting threads in the summary buffer.
834 By default, threads are sorted by article number.
835
836 Each function takes two threads and returns non-nil if the first
837 thread should be sorted before the other.  If you use more than one
838 function, the primary sort function should be the last.  You should
839 probably always include `gnus-thread-sort-by-number' in the list of
840 sorting functions -- preferably first.  Also note that sorting by date
841 is often much slower than sorting by number, and the sorting order is
842 very similar.  (Sorting by date means sorting by the time the message
843 was sent, sorting by number means sorting by arrival time.)
844
845 Each list item can also be a list `(not F)' where F is a
846 function; this specifies reversed sort order.
847
848 Ready-made functions include `gnus-thread-sort-by-number',
849 `gnus-thread-sort-by-author', `gnus-thread-sort-by-recipient'
850 `gnus-thread-sort-by-subject', `gnus-thread-sort-by-date',
851 `gnus-thread-sort-by-score', `gnus-thread-sort-by-most-recent-number',
852 `gnus-thread-sort-by-most-recent-date', `gnus-thread-sort-by-random',
853 and `gnus-thread-sort-by-total-score' (see
854 `gnus-thread-score-function').
855
856 When threading is turned off, the variable
857 `gnus-article-sort-functions' controls how articles are sorted."
858   :group 'gnus-summary-sort
859   :type '(repeat
860           (gnus-widget-reversible
861            (choice (function-item gnus-thread-sort-by-number)
862                    (function-item gnus-thread-sort-by-author)
863                    (function-item gnus-thread-sort-by-recipient)
864                    (function-item gnus-thread-sort-by-subject)
865                    (function-item gnus-thread-sort-by-date)
866                    (function-item gnus-thread-sort-by-score)
867                    (function-item gnus-thread-sort-by-most-recent-number)
868                    (function-item gnus-thread-sort-by-most-recent-date)
869                    (function-item gnus-thread-sort-by-random)
870                    (function-item gnus-thread-sort-by-total-score)
871                    (function :tag "other"))
872            (boolean :tag "Reverse order"))))
873
874 (defcustom gnus-thread-score-function '+
875   "*Function used for calculating the total score of a thread.
876
877 The function is called with the scores of the article and each
878 subthread and should then return the score of the thread.
879
880 Some functions you can use are `+', `max', or `min'."
881   :group 'gnus-summary-sort
882   :type 'function)
883
884 (defcustom gnus-summary-expunge-below nil
885   "All articles that have a score less than this variable will be expunged.
886 This variable is local to the summary buffers."
887   :group 'gnus-score-default
888   :type '(choice (const :tag "off" nil)
889                  integer))
890
891 (defcustom gnus-thread-expunge-below nil
892   "All threads that have a total score less than this variable will be expunged.
893 See `gnus-thread-score-function' for en explanation of what a
894 \"thread score\" is.
895
896 This variable is local to the summary buffers."
897   :group 'gnus-threading
898   :group 'gnus-score-default
899   :type '(choice (const :tag "off" nil)
900                  integer))
901
902 (defcustom gnus-summary-mode-hook nil
903   "*A hook for Gnus summary mode.
904 This hook is run before any variables are set in the summary buffer."
905   :options '(turn-on-gnus-mailing-list-mode gnus-pick-mode)
906   :group 'gnus-summary-various
907   :type 'hook)
908
909 ;; Extracted from gnus-xmas-redefine in order to preserve user settings
910 (when (featurep 'xemacs)
911   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-summary-menu-add)
912   (add-hook 'gnus-summary-mode-hook 'gnus-xmas-setup-summary-toolbar)
913   (add-hook 'gnus-summary-mode-hook
914             'gnus-xmas-switch-horizontal-scrollbar-off))
915
916 (defcustom gnus-summary-menu-hook nil
917   "*Hook run after the creation of the summary mode menu."
918   :group 'gnus-summary-visual
919   :type 'hook)
920
921 (defcustom gnus-summary-exit-hook nil
922   "*A hook called on exit from the summary buffer.
923 It will be called with point in the group buffer."
924   :group 'gnus-summary-exit
925   :type 'hook)
926
927 (defcustom gnus-summary-prepare-hook nil
928   "*A hook called after the summary buffer has been generated.
929 If you want to modify the summary buffer, you can use this hook."
930   :group 'gnus-summary-various
931   :type 'hook)
932
933 (defcustom gnus-summary-prepared-hook nil
934   "*A hook called as the last thing after the summary buffer has been generated."
935   :group 'gnus-summary-various
936   :type 'hook)
937
938 (defcustom gnus-summary-generate-hook nil
939   "*A hook run just before generating the summary buffer.
940 This hook is commonly used to customize threading variables and the
941 like."
942   :group 'gnus-summary-various
943   :type 'hook)
944
945 (defcustom gnus-select-group-hook nil
946   "*A hook called when a newsgroup is selected.
947
948 If you'd like to simplify subjects like the
949 `gnus-summary-next-same-subject' command does, you can use the
950 following hook:
951
952  (add-hook gnus-select-group-hook
953            (lambda ()
954              (mapcar (lambda (header)
955                        (mail-header-set-subject
956                         header
957                         (gnus-simplify-subject
958                          (mail-header-subject header) 're-only)))
959                      gnus-newsgroup-headers)))"
960   :group 'gnus-group-select
961   :type 'hook)
962
963 (defcustom gnus-select-article-hook nil
964   "*A hook called when an article is selected."
965   :group 'gnus-summary-choose
966   :options '(gnus-agent-fetch-selected-article)
967   :type 'hook)
968
969 (defcustom gnus-visual-mark-article-hook
970   (list 'gnus-highlight-selected-summary)
971   "*Hook run after selecting an article in the summary buffer.
972 It is meant to be used for highlighting the article in some way.  It
973 is not run if `gnus-visual' is nil."
974   :group 'gnus-summary-visual
975   :type 'hook)
976
977 (defcustom gnus-parse-headers-hook nil
978   "*A hook called before parsing the headers."
979   :group 'gnus-various
980   :type 'hook)
981
982 (defcustom gnus-exit-group-hook nil
983   "*A hook called when exiting summary mode.
984 This hook is not called from the non-updating exit commands like `Q'."
985   :group 'gnus-various
986   :type 'hook)
987
988 (defcustom gnus-summary-update-hook nil
989   "*A hook called when a summary line is changed.
990 The hook will not be called if `gnus-visual' is nil.
991
992 The default function `gnus-summary-highlight-line' will
993 highlight the line according to the `gnus-summary-highlight'
994 variable."
995   :group 'gnus-summary-visual
996   :type 'hook)
997
998 (defcustom gnus-mark-article-hook '(gnus-summary-mark-read-and-unread-as-read)
999   "*A hook called when an article is selected for the first time.
1000 The hook is intended to mark an article as read (or unread)
1001 automatically when it is selected."
1002   :group 'gnus-summary-choose
1003   :type 'hook)
1004
1005 (defcustom gnus-group-no-more-groups-hook nil
1006   "*A hook run when returning to group mode having no more (unread) groups."
1007   :group 'gnus-group-select
1008   :type 'hook)
1009
1010 (defcustom gnus-ps-print-hook nil
1011   "*A hook run before ps-printing something from Gnus."
1012   :group 'gnus-summary
1013   :type 'hook)
1014
1015 (defcustom gnus-summary-article-move-hook nil
1016   "*A hook called after an article is moved, copied, respooled, or crossposted."
1017   :version "22.1"
1018   :group 'gnus-summary
1019   :type 'hook)
1020
1021 (defcustom gnus-summary-article-delete-hook nil
1022   "*A hook called after an article is deleted."
1023   :version "22.1"
1024   :group 'gnus-summary
1025   :type 'hook)
1026
1027 (defcustom gnus-summary-article-expire-hook nil
1028   "*A hook called after an article is expired."
1029   :version "22.1"
1030   :group 'gnus-summary
1031   :type 'hook)
1032
1033 (defcustom gnus-summary-display-arrow
1034   (and (fboundp 'display-graphic-p)
1035        (display-graphic-p))
1036   "*If non-nil, display an arrow highlighting the current article."
1037   :version "22.1"
1038   :group 'gnus-summary
1039   :type 'boolean)
1040
1041 (defcustom gnus-summary-selected-face 'gnus-summary-selected
1042   "Face used for highlighting the current article in the summary buffer."
1043   :group 'gnus-summary-visual
1044   :type 'face)
1045
1046 (defvar gnus-tmp-downloaded nil)
1047
1048 (defcustom gnus-summary-highlight
1049   '(((eq mark gnus-canceled-mark)
1050      . gnus-summary-cancelled)
1051     ((and uncached (> score default-high))
1052      . gnus-summary-high-undownloaded)
1053     ((and uncached (< score default-low))
1054      . gnus-summary-low-undownloaded)
1055     (uncached
1056      . gnus-summary-normal-undownloaded)
1057     ((and (> score default-high)
1058           (or (eq mark gnus-dormant-mark)
1059               (eq mark gnus-ticked-mark)))
1060      . gnus-summary-high-ticked)
1061     ((and (< score default-low)
1062           (or (eq mark gnus-dormant-mark)
1063               (eq mark gnus-ticked-mark)))
1064      . gnus-summary-low-ticked)
1065     ((or (eq mark gnus-dormant-mark)
1066          (eq mark gnus-ticked-mark))
1067      . gnus-summary-normal-ticked)
1068     ((and (> score default-high) (eq mark gnus-ancient-mark))
1069      . gnus-summary-high-ancient)
1070     ((and (< score default-low) (eq mark gnus-ancient-mark))
1071      . gnus-summary-low-ancient)
1072     ((eq mark gnus-ancient-mark)
1073      . gnus-summary-normal-ancient)
1074     ((and (> score default-high) (eq mark gnus-unread-mark))
1075      . gnus-summary-high-unread)
1076     ((and (< score default-low) (eq mark gnus-unread-mark))
1077      . gnus-summary-low-unread)
1078     ((eq mark gnus-unread-mark)
1079      . gnus-summary-normal-unread)
1080     ((> score default-high)
1081      . gnus-summary-high-read)
1082     ((< score default-low)
1083      . gnus-summary-low-read)
1084     (t
1085      . gnus-summary-normal-read))
1086   "*Controls the highlighting of summary buffer lines.
1087
1088 A list of (FORM . FACE) pairs.  When deciding how a particular
1089 summary line should be displayed, each form is evaluated.  The content
1090 of the face field after the first true form is used.  You can change
1091 how those summary lines are displayed, by editing the face field.
1092
1093 You can use the following variables in the FORM field.
1094
1095 score:        The article's score.
1096 default:      The default article score.
1097 default-high: The default score for high scored articles.
1098 default-low:  The default score for low scored articles.
1099 below:        The score below which articles are automatically marked as read.
1100 mark:         The article's mark.
1101 uncached:     Non-nil if the article is uncached."
1102   :group 'gnus-summary-visual
1103   :type '(repeat (cons (sexp :tag "Form" nil)
1104                        face)))
1105 (put 'gnus-summary-highlight 'risky-local-variable t)
1106
1107 (defcustom gnus-alter-header-function nil
1108   "Function called to allow alteration of article header structures.
1109 The function is called with one parameter, the article header vector,
1110 which it may alter in any way."
1111   :type '(choice (const :tag "None" nil)
1112                  function)
1113   :group 'gnus-summary)
1114
1115 (defvar gnus-decode-encoded-word-function 'mail-decode-encoded-word-string
1116   "Function used to decode a string with encoded words.")
1117
1118 (defvar gnus-decode-encoded-address-function
1119   'mail-decode-encoded-address-string
1120   "Function used to decode addresses with encoded words.")
1121
1122 (defcustom gnus-extra-headers '(To Newsgroups)
1123   "*Extra headers to parse."
1124   :version "21.1"
1125   :group 'gnus-summary
1126   :type '(repeat symbol))
1127
1128 (defcustom gnus-ignored-from-addresses
1129   (and user-mail-address
1130        (not (string= user-mail-address ""))
1131        (regexp-quote user-mail-address))
1132   "*From headers that may be suppressed in favor of To headers.
1133 This can be a regexp or a list of regexps."
1134   :version "21.1"
1135   :group 'gnus-summary
1136   :type '(choice regexp
1137                  (repeat :tag "Regexp List" regexp)))
1138
1139 (defsubst gnus-ignored-from-addresses ()
1140   (gmm-regexp-concat gnus-ignored-from-addresses))
1141
1142 (defcustom gnus-summary-to-prefix "-> "
1143   "*String prefixed to the To field in the summary line when
1144 using `gnus-ignored-from-addresses'."
1145   :version "22.1"
1146   :group 'gnus-summary
1147   :type 'string)
1148
1149 (defcustom gnus-summary-newsgroup-prefix "=> "
1150   "*String prefixed to the Newsgroup field in the summary
1151 line when using `gnus-ignored-from-addresses'."
1152   :version "22.1"
1153   :group 'gnus-summary
1154   :type 'string)
1155
1156 (defcustom gnus-newsgroup-ignored-charsets '(unknown-8bit x-unknown)
1157   "List of charsets that should be ignored.
1158 When these charsets are used in the \"charset\" parameter, the
1159 default charset will be used instead."
1160   :version "21.1"
1161   :type '(repeat symbol)
1162   :group 'gnus-charset)
1163
1164 (defcustom gnus-newsgroup-maximum-articles nil
1165   "The maximum number of articles a newsgroup.
1166 If this is a number, old articles in a newsgroup exceeding this number
1167 are silently ignored.  If it is nil, no article is ignored.  Note that
1168 setting this variable to a number might prevent you from reading very
1169 old articles."
1170   :group 'gnus-group-select
1171   :version "22.2"
1172   :type '(choice (const :tag "No limit" nil)
1173                  integer))
1174
1175 (gnus-define-group-parameter
1176  ignored-charsets
1177  :type list
1178  :function-document
1179  "Return the ignored charsets of GROUP."
1180  :variable gnus-group-ignored-charsets-alist
1181  :variable-default
1182  '(("alt\\.chinese\\.text" iso-8859-1))
1183  :variable-document
1184  "Alist of regexps (to match group names) and charsets that should be ignored.
1185 When these charsets are used in the \"charset\" parameter, the
1186 default charset will be used instead."
1187  :variable-group gnus-charset
1188  :variable-type '(repeat (cons (regexp :tag "Group")
1189                                (repeat symbol)))
1190  :parameter-type '(choice :tag "Ignored charsets"
1191                           :value nil
1192                           (repeat (symbol)))
1193  :parameter-document       "\
1194 List of charsets that should be ignored.
1195
1196 When these charsets are used in the \"charset\" parameter, the
1197 default charset will be used instead.")
1198
1199 (defcustom gnus-group-highlight-words-alist nil
1200   "Alist of group regexps and highlight regexps.
1201 This variable uses the same syntax as `gnus-emphasis-alist'."
1202   :version "21.1"
1203   :type '(repeat (cons (regexp :tag "Group")
1204                        (repeat (list (regexp :tag "Highlight regexp")
1205                                      (number :tag "Group for entire word" 0)
1206                                      (number :tag "Group for displayed part" 0)
1207                                      (symbol :tag "Face"
1208                                              gnus-emphasis-highlight-words)))))
1209   :group 'gnus-summary-visual)
1210
1211 (defcustom gnus-summary-show-article-charset-alist
1212   nil
1213   "Alist of number and charset.
1214 The article will be shown with the charset corresponding to the
1215 numbered argument.
1216 For example: ((1 . cn-gb-2312) (2 . big5))."
1217   :version "21.1"
1218   :type '(repeat (cons (number :tag "Argument" 1)
1219                        (symbol :tag "Charset")))
1220   :group 'gnus-charset)
1221
1222 (defcustom gnus-preserve-marks t
1223   "Whether marks are preserved when moving, copying and respooling messages."
1224   :version "21.1"
1225   :type 'boolean
1226   :group 'gnus-summary-marks)
1227
1228 (defcustom gnus-propagate-marks t
1229   "If non-nil, do not propagate marks to the backends."
1230   :version "23.1" ;; No Gnus
1231   :type 'boolean
1232   :group 'gnus-summary-marks)
1233
1234 (defcustom gnus-alter-articles-to-read-function nil
1235   "Function to be called to alter the list of articles to be selected."
1236   :type '(choice (const nil) function)
1237   :group 'gnus-summary)
1238
1239 (defcustom gnus-orphan-score nil
1240   "*All orphans get this score added.  Set in the score file."
1241   :group 'gnus-score-default
1242   :type '(choice (const nil)
1243                  integer))
1244
1245 (defcustom gnus-summary-save-parts-default-mime "image/.*"
1246   "*A regexp to match MIME parts when saving multiple parts of a
1247 message with `gnus-summary-save-parts' (\\<gnus-summary-mode-map>\\[gnus-summary-save-parts]).
1248 This regexp will be used by default when prompting the user for which
1249 type of files to save."
1250   :group 'gnus-summary
1251   :type 'regexp)
1252
1253 (defcustom gnus-read-all-available-headers nil
1254   "Whether Gnus should parse all headers made available to it.
1255 This is mostly relevant for slow back ends where the user may
1256 wish to widen the summary buffer to include all headers
1257 that were fetched."
1258   :version "22.1"
1259   :group 'gnus-summary
1260   :type '(choice boolean regexp))
1261
1262 (defcustom gnus-summary-pipe-output-default-command nil
1263   "Command (and optional arguments) used to pipe article to subprocess.
1264 This will be used as the default command if it is non-nil.  The value
1265 will be updated if you modify it when executing the command
1266 `gnus-summary-pipe-output' or the function `gnus-summary-save-in-pipe'."
1267   :version "23.1" ;; No Gnus
1268   :group 'gnus-summary
1269   :type '(radio (const :tag "None" nil) (string :tag "Command")))
1270
1271 (defcustom gnus-summary-muttprint-program "muttprint"
1272   "Command (and optional arguments) used to run Muttprint.
1273 The value will be updated if you modify it when executing the command
1274 `gnus-summary-muttprint'."
1275   :version "22.1"
1276   :group 'gnus-summary
1277   :type 'string)
1278
1279 (defcustom gnus-article-loose-mime t
1280   "If non-nil, don't require MIME-Version header.
1281 Some brain-damaged MUA/MTA, e.g. Lotus Domino 5.0.6 clients, does not
1282 supply the MIME-Version header or deliberately strip it from the mail.
1283 If non-nil (the default), Gnus will treat some articles as MIME
1284 even if the MIME-Version header is missing."
1285   :version "22.1"
1286   :type 'boolean
1287   :group 'gnus-article-mime)
1288
1289 (defcustom gnus-article-emulate-mime t
1290   "If non-nil, use MIME emulation for uuencode and the like.
1291 This means that Gnus will search message bodies for text that look
1292 like uuencoded bits, yEncoded bits, and so on, and present that using
1293 the normal Gnus MIME machinery."
1294   :version "22.1"
1295   :type 'boolean
1296   :group 'gnus-article-mime)
1297
1298 ;;; Internal variables
1299
1300 (defvar gnus-summary-display-cache nil)
1301 (defvar gnus-article-mime-handles nil)
1302 (defvar gnus-article-decoded-p nil)
1303 (defvar gnus-article-charset nil)
1304 (defvar gnus-article-ignored-charsets nil)
1305 (defvar gnus-scores-exclude-files nil)
1306 (defvar gnus-page-broken nil)
1307
1308 (defvar gnus-original-article nil)
1309 (defvar gnus-article-internal-prepare-hook nil)
1310 (defvar gnus-newsgroup-process-stack nil)
1311
1312 (defvar gnus-thread-indent-array nil)
1313 (defvar gnus-thread-indent-array-level gnus-thread-indent-level)
1314 (defvar gnus-sort-gathered-threads-function 'gnus-thread-sort-by-number
1315   "Function called to sort the articles within a thread after it has been gathered together.")
1316
1317 (defvar gnus-summary-save-parts-type-history nil)
1318 (defvar gnus-summary-save-parts-last-directory mm-default-directory)
1319
1320 ;; Avoid highlighting in kill files.
1321 (defvar gnus-summary-inhibit-highlight nil)
1322 (defvar gnus-newsgroup-selected-overlay nil)
1323 (defvar gnus-inhibit-limiting nil)
1324 (defvar gnus-newsgroup-adaptive-score-file nil)
1325 (defvar gnus-current-score-file nil)
1326 (defvar gnus-current-move-group nil)
1327 (defvar gnus-current-copy-group nil)
1328 (defvar gnus-current-crosspost-group nil)
1329 (defvar gnus-newsgroup-display nil)
1330
1331 (defvar gnus-newsgroup-dependencies nil)
1332 (defvar gnus-newsgroup-adaptive nil)
1333 (defvar gnus-summary-display-article-function nil)
1334 (defvar gnus-summary-highlight-line-function nil
1335   "Function called after highlighting a summary line.")
1336
1337 (defvar gnus-summary-line-format-alist
1338   `((?N ,(macroexpand '(mail-header-number gnus-tmp-header)) ?d)
1339     (?S ,(macroexpand '(mail-header-subject gnus-tmp-header)) ?s)
1340     (?s gnus-tmp-subject-or-nil ?s)
1341     (?n gnus-tmp-name ?s)
1342     (?A (car (cdr (funcall gnus-extract-address-components gnus-tmp-from)))
1343         ?s)
1344     (?a (or (car (funcall gnus-extract-address-components gnus-tmp-from))
1345             gnus-tmp-from) ?s)
1346     (?F gnus-tmp-from ?s)
1347     (?x ,(macroexpand '(mail-header-xref gnus-tmp-header)) ?s)
1348     (?D ,(macroexpand '(mail-header-date gnus-tmp-header)) ?s)
1349     (?d (gnus-dd-mmm (mail-header-date gnus-tmp-header)) ?s)
1350     (?o (gnus-date-iso8601 (mail-header-date gnus-tmp-header)) ?s)
1351     (?M ,(macroexpand '(mail-header-id gnus-tmp-header)) ?s)
1352     (?r ,(macroexpand '(mail-header-references gnus-tmp-header)) ?s)
1353     (?c (or (mail-header-chars gnus-tmp-header) 0) ?d)
1354     (?k (gnus-summary-line-message-size gnus-tmp-header) ?s)
1355     (?L gnus-tmp-lines ?s)
1356     (?O gnus-tmp-downloaded ?c)
1357     (?I gnus-tmp-indentation ?s)
1358     (?T (if (= gnus-tmp-level 0) "" (make-string (frame-width) ? )) ?s)
1359     (?R gnus-tmp-replied ?c)
1360     (?\[ gnus-tmp-opening-bracket ?c)
1361     (?\] gnus-tmp-closing-bracket ?c)
1362     (?\> (make-string gnus-tmp-level ? ) ?s)
1363     (?\< (make-string (max 0 (- 20 gnus-tmp-level)) ? ) ?s)
1364     (?i gnus-tmp-score ?d)
1365     (?z gnus-tmp-score-char ?c)
1366     (?V (gnus-thread-total-score (and (boundp 'thread) (car thread))) ?d)
1367     (?U gnus-tmp-unread ?c)
1368     (?f (gnus-summary-from-or-to-or-newsgroups gnus-tmp-header gnus-tmp-from)
1369         ?s)
1370     (?t (gnus-summary-number-of-articles-in-thread
1371          (and (boundp 'thread) (car thread)) gnus-tmp-level)
1372         ?d)
1373     (?e (gnus-summary-number-of-articles-in-thread
1374          (and (boundp 'thread) (car thread)) gnus-tmp-level t)
1375         ?c)
1376     (?u gnus-tmp-user-defined ?s)
1377     (?P (gnus-pick-line-number) ?d)
1378     (?B gnus-tmp-thread-tree-header-string ?s)
1379     (user-date (gnus-user-date
1380                 ,(macroexpand '(mail-header-date gnus-tmp-header))) ?s))
1381   "An alist of format specifications that can appear in summary lines.
1382 These are paired with what variables they correspond with, along with
1383 the type of the variable (string, integer, character, etc).")
1384
1385 (defvar gnus-summary-dummy-line-format-alist
1386   `((?S gnus-tmp-subject ?s)
1387     (?N gnus-tmp-number ?d)
1388     (?u gnus-tmp-user-defined ?s)))
1389
1390 (defvar gnus-summary-mode-line-format-alist
1391   `((?G gnus-tmp-group-name ?s)
1392     (?g (gnus-short-group-name gnus-tmp-group-name) ?s)
1393     (?p (gnus-group-real-name gnus-tmp-group-name) ?s)
1394     (?A gnus-tmp-article-number ?d)
1395     (?Z gnus-tmp-unread-and-unselected ?s)
1396     (?V gnus-version ?s)
1397     (?U gnus-tmp-unread-and-unticked ?d)
1398     (?S gnus-tmp-subject ?s)
1399     (?e gnus-tmp-unselected ?d)
1400     (?u gnus-tmp-user-defined ?s)
1401     (?d (length gnus-newsgroup-dormant) ?d)
1402     (?t (length gnus-newsgroup-marked) ?d)
1403     (?h (length gnus-newsgroup-spam-marked) ?d)
1404     (?r (length gnus-newsgroup-reads) ?d)
1405     (?z (gnus-summary-article-score gnus-tmp-article-number) ?d)
1406     (?E gnus-newsgroup-expunged-tally ?d)
1407     (?s (gnus-current-score-file-nondirectory) ?s)))
1408
1409 ;; This is here rather than in gnus-art for compilation reasons.
1410 (defvar gnus-article-mode-line-format-alist
1411   (nconc '((?w (gnus-article-wash-status) ?s)
1412            (?m (gnus-article-mime-part-status) ?s))
1413          gnus-summary-mode-line-format-alist))
1414
1415 (defvar gnus-last-search-regexp nil
1416   "Default regexp for article search command.")
1417
1418 (defvar gnus-last-shell-command nil
1419   "Default shell command on article.")
1420
1421 (defvar gnus-newsgroup-agentized nil
1422   "Locally bound in each summary buffer to indicate whether the server has been agentized.")
1423 (defvar gnus-newsgroup-begin nil)
1424 (defvar gnus-newsgroup-end nil)
1425 (defvar gnus-newsgroup-last-rmail nil)
1426 (defvar gnus-newsgroup-last-mail nil)
1427 (defvar gnus-newsgroup-last-folder nil)
1428 (defvar gnus-newsgroup-last-file nil)
1429 (defvar gnus-newsgroup-last-directory nil)
1430 (defvar gnus-newsgroup-auto-expire nil)
1431 (defvar gnus-newsgroup-active nil)
1432
1433 (defvar gnus-newsgroup-data nil)
1434 (defvar gnus-newsgroup-data-reverse nil)
1435 (defvar gnus-newsgroup-limit nil)
1436 (defvar gnus-newsgroup-limits nil)
1437 (defvar gnus-summary-use-undownloaded-faces nil)
1438
1439 (defvar gnus-newsgroup-unreads nil
1440   "Sorted list of unread articles in the current newsgroup.")
1441
1442 (defvar gnus-newsgroup-unselected nil
1443   "Sorted list of unselected unread articles in the current newsgroup.")
1444
1445 (defvar gnus-newsgroup-reads nil
1446   "Alist of read articles and article marks in the current newsgroup.")
1447
1448 (defvar gnus-newsgroup-expunged-tally nil)
1449
1450 (defvar gnus-newsgroup-marked nil
1451   "Sorted list of ticked articles in the current newsgroup (a subset of unread art).")
1452
1453 (defvar gnus-newsgroup-spam-marked nil
1454   "List of ranges of articles that have been marked as spam.")
1455
1456 (defvar gnus-newsgroup-killed nil
1457   "List of ranges of articles that have been through the scoring process.")
1458
1459 (defvar gnus-newsgroup-cached nil
1460   "Sorted list of articles that come from the article cache.")
1461
1462 (defvar gnus-newsgroup-saved nil
1463   "List of articles that have been saved.")
1464
1465 (defvar gnus-newsgroup-kill-headers nil)
1466
1467 (defvar gnus-newsgroup-replied nil
1468   "List of articles that have been replied to in the current newsgroup.")
1469
1470 (defvar gnus-newsgroup-forwarded nil
1471   "List of articles that have been forwarded in the current newsgroup.")
1472
1473 (defvar gnus-newsgroup-recent nil
1474   "List of articles that have are recent in the current newsgroup.")
1475
1476 (defvar gnus-newsgroup-expirable nil
1477   "Sorted list of articles in the current newsgroup that can be expired.")
1478
1479 (defvar gnus-newsgroup-processable nil
1480   "List of articles in the current newsgroup that can be processed.")
1481
1482 (defvar gnus-newsgroup-downloadable nil
1483   "Sorted list of articles in the current newsgroup that can be processed.")
1484
1485 (defvar gnus-newsgroup-unfetched nil
1486   "Sorted list of articles in the current newsgroup whose headers have
1487 not been fetched into the agent.
1488
1489 This list will always be a subset of gnus-newsgroup-undownloaded.")
1490
1491 (defvar gnus-newsgroup-undownloaded nil
1492   "List of articles in the current newsgroup that haven't been downloaded.")
1493
1494 (defvar gnus-newsgroup-unsendable nil
1495   "List of articles in the current newsgroup that won't be sent.")
1496
1497 (defvar gnus-newsgroup-bookmarks nil
1498   "List of articles in the current newsgroup that have bookmarks.")
1499
1500 (defvar gnus-newsgroup-dormant nil
1501   "Sorted list of dormant articles in the current newsgroup.")
1502
1503 (defvar gnus-newsgroup-unseen nil
1504   "List of unseen articles in the current newsgroup.")
1505
1506 (defvar gnus-newsgroup-seen nil
1507   "Range of seen articles in the current newsgroup.")
1508
1509 (defvar gnus-newsgroup-articles nil
1510   "List of articles in the current newsgroup.")
1511
1512 (defvar gnus-newsgroup-scored nil
1513   "List of scored articles in the current newsgroup.")
1514
1515 (defvar gnus-newsgroup-headers nil
1516   "List of article headers in the current newsgroup.")
1517
1518 (defvar gnus-newsgroup-threads nil)
1519
1520 (defvar gnus-newsgroup-prepared nil
1521   "Whether the current group has been prepared properly.")
1522
1523 (defvar gnus-newsgroup-ancient nil
1524   "List of `gnus-fetch-old-headers' articles in the current newsgroup.")
1525
1526 (defvar gnus-newsgroup-sparse nil)
1527
1528 (defvar gnus-current-article nil)
1529 (defvar gnus-article-current nil)
1530 (defvar gnus-current-headers nil)
1531 (defvar gnus-have-all-headers nil)
1532 (defvar gnus-last-article nil)
1533 (defvar gnus-newsgroup-history nil)
1534 (defvar gnus-newsgroup-charset nil)
1535 (defvar gnus-newsgroup-ephemeral-charset nil)
1536 (defvar gnus-newsgroup-ephemeral-ignored-charsets nil)
1537
1538 (defvar gnus-article-before-search nil)
1539
1540 (defvar gnus-summary-local-variables
1541   '(gnus-newsgroup-name
1542     gnus-newsgroup-begin gnus-newsgroup-end
1543     gnus-newsgroup-last-rmail gnus-newsgroup-last-mail
1544     gnus-newsgroup-last-folder gnus-newsgroup-last-file
1545     gnus-newsgroup-last-directory
1546     gnus-newsgroup-auto-expire gnus-newsgroup-unreads
1547     gnus-newsgroup-unselected gnus-newsgroup-marked
1548     gnus-newsgroup-spam-marked
1549     gnus-newsgroup-reads gnus-newsgroup-saved
1550     gnus-newsgroup-replied gnus-newsgroup-forwarded
1551     gnus-newsgroup-recent
1552     gnus-newsgroup-expirable
1553     gnus-newsgroup-processable gnus-newsgroup-killed
1554     gnus-newsgroup-downloadable gnus-newsgroup-undownloaded
1555     gnus-newsgroup-unfetched
1556     gnus-newsgroup-unsendable gnus-newsgroup-unseen
1557     gnus-newsgroup-seen gnus-newsgroup-articles
1558     gnus-newsgroup-bookmarks gnus-newsgroup-dormant
1559     gnus-newsgroup-headers gnus-newsgroup-threads
1560     gnus-newsgroup-prepared gnus-summary-highlight-line-function
1561     gnus-current-article gnus-current-headers gnus-have-all-headers
1562     gnus-last-article gnus-article-internal-prepare-hook
1563     gnus-newsgroup-dependencies gnus-newsgroup-selected-overlay
1564     gnus-newsgroup-scored gnus-newsgroup-kill-headers
1565     gnus-thread-expunge-below
1566     gnus-score-alist gnus-current-score-file
1567     (gnus-summary-expunge-below . global)
1568     (gnus-summary-mark-below . global)
1569     (gnus-orphan-score . global)
1570     gnus-newsgroup-active gnus-scores-exclude-files
1571     gnus-newsgroup-history gnus-newsgroup-ancient
1572     gnus-newsgroup-sparse gnus-newsgroup-process-stack
1573     (gnus-newsgroup-adaptive . gnus-use-adaptive-scoring)
1574     gnus-newsgroup-adaptive-score-file (gnus-reffed-article-number . -1)
1575     (gnus-newsgroup-expunged-tally . 0)
1576     gnus-cache-removable-articles gnus-newsgroup-cached
1577     gnus-newsgroup-data gnus-newsgroup-data-reverse
1578     gnus-newsgroup-limit gnus-newsgroup-limits
1579     gnus-newsgroup-charset gnus-newsgroup-display
1580     gnus-summary-use-undownloaded-faces)
1581   "Variables that are buffer-local to the summary buffers.")
1582
1583 (defvar gnus-newsgroup-variables nil
1584   "A list of variables that have separate values in different newsgroups.
1585 A list of newsgroup (summary buffer) local variables, or cons of
1586 variables and their default expressions to be evalled (when the default
1587 values are not nil), that should be made global while the summary buffer
1588 is active.
1589
1590 Note: The default expressions will be evaluated (using function `eval')
1591 before assignment to the local variable rather than just assigned to it.
1592 If the default expression is the symbol `global', that symbol will not
1593 be evaluated but the global value of the local variable will be used
1594 instead.
1595
1596 These variables can be used to set variables in the group parameters
1597 while still allowing them to affect operations done in other buffers.
1598 For example:
1599
1600 \(setq gnus-newsgroup-variables
1601      '(message-use-followup-to
1602        (gnus-visible-headers .
1603          \"^From:\\\\|^Newsgroups:\\\\|^Subject:\\\\|^Date:\\\\|^To:\")))
1604 ")
1605
1606 (eval-when-compile
1607   ;; Bind features so that require will believe that gnus-sum has
1608   ;; already been loaded (avoids infinite recursion)
1609   (let ((features (cons 'gnus-sum features)))
1610     (require 'gnus-art)))
1611
1612 ;; MIME stuff.
1613
1614 (defvar gnus-decode-encoded-word-methods
1615   '(mail-decode-encoded-word-string)
1616   "List of methods used to decode encoded words.
1617
1618 This variable is a list of FUNCTION or (REGEXP . FUNCTION).  If item
1619 is FUNCTION, FUNCTION will be apply to all newsgroups.  If item is a
1620 \(REGEXP . FUNCTION), FUNCTION will be only apply to thes newsgroups
1621 whose names match REGEXP.
1622
1623 For example:
1624 \((\"chinese\" . gnus-decode-encoded-word-string-by-guess)
1625  mail-decode-encoded-word-string
1626  (\"chinese\" . rfc1843-decode-string))")
1627
1628 (defvar gnus-decode-encoded-word-methods-cache nil)
1629
1630 (defun gnus-multi-decode-encoded-word-string (string)
1631   "Apply the functions from `gnus-encoded-word-methods' that match."
1632   (unless (and gnus-decode-encoded-word-methods-cache
1633                (eq gnus-newsgroup-name
1634                    (car gnus-decode-encoded-word-methods-cache)))
1635     (setq gnus-decode-encoded-word-methods-cache (list gnus-newsgroup-name))
1636     (dolist (method gnus-decode-encoded-word-methods)
1637       (if (symbolp method)
1638           (nconc gnus-decode-encoded-word-methods-cache (list method))
1639         (if (and gnus-newsgroup-name
1640                  (string-match (car method) gnus-newsgroup-name))
1641             (nconc gnus-decode-encoded-word-methods-cache
1642                    (list (cdr method)))))))
1643   (dolist (method (cdr gnus-decode-encoded-word-methods-cache) string)
1644     (setq string (funcall method string))))
1645
1646 ;; Subject simplification.
1647
1648 (defun gnus-simplify-whitespace (str)
1649   "Remove excessive whitespace from STR."
1650   ;; Multiple spaces.
1651   (while (string-match "[ \t][ \t]+" str)
1652     (setq str (concat (substring str 0 (match-beginning 0))
1653                         " "
1654                         (substring str (match-end 0)))))
1655   ;; Leading spaces.
1656   (when (string-match "^[ \t]+" str)
1657     (setq str (substring str (match-end 0))))
1658   ;; Trailing spaces.
1659   (when (string-match "[ \t]+$" str)
1660     (setq str (substring str 0 (match-beginning 0))))
1661   str)
1662
1663 (defun gnus-simplify-all-whitespace (str)
1664   "Remove all whitespace from STR."
1665   (while (string-match "[ \t\n]+" str)
1666     (setq str (replace-match "" nil nil str)))
1667   str)
1668
1669 (defsubst gnus-simplify-subject-re (subject)
1670   "Remove \"Re:\" from subject lines."
1671   (if (string-match message-subject-re-regexp subject)
1672       (substring subject (match-end 0))
1673     subject))
1674
1675 (defun gnus-simplify-subject (subject &optional re-only)
1676   "Remove `Re:' and words in parentheses.
1677 If RE-ONLY is non-nil, strip leading `Re:'s only."
1678   (let ((case-fold-search t))           ;Ignore case.
1679     ;; Remove `Re:', `Re^N:', `Re(n)', and `Re[n]:'.
1680     (when (string-match "\\`\\(re\\([[(^][0-9]+[])]?\\)?:[ \t]*\\)+" subject)
1681       (setq subject (substring subject (match-end 0))))
1682     ;; Remove uninteresting prefixes.
1683     (when (and (not re-only)
1684                gnus-simplify-ignored-prefixes
1685                (string-match gnus-simplify-ignored-prefixes subject))
1686       (setq subject (substring subject (match-end 0))))
1687     ;; Remove words in parentheses from end.
1688     (unless re-only
1689       (while (string-match "[ \t\n]*([^()]*)[ \t\n]*\\'" subject)
1690         (setq subject (substring subject 0 (match-beginning 0)))))
1691     ;; Return subject string.
1692     subject))
1693
1694 ;; Remove any leading "re:"s, any trailing paren phrases, and simplify
1695 ;; all whitespace.
1696 (defsubst gnus-simplify-buffer-fuzzy-step (regexp &optional newtext)
1697   (goto-char (point-min))
1698   (while (re-search-forward regexp nil t)
1699     (replace-match (or newtext ""))))
1700
1701 (defun gnus-simplify-buffer-fuzzy ()
1702   "Simplify string in the buffer fuzzily.
1703 The string in the accessible portion of the current buffer is simplified.
1704 It is assumed to be a single-line subject.
1705 Whitespace is generally cleaned up, and miscellaneous leading/trailing
1706 matter is removed.  Additional things can be deleted by setting
1707 `gnus-simplify-subject-fuzzy-regexp'."
1708   (let ((case-fold-search t)
1709         (modified-tick))
1710     (gnus-simplify-buffer-fuzzy-step "\t" " ")
1711
1712     (while (not (eq modified-tick (buffer-modified-tick)))
1713       (setq modified-tick (buffer-modified-tick))
1714       (cond
1715        ((listp gnus-simplify-subject-fuzzy-regexp)
1716         (mapc 'gnus-simplify-buffer-fuzzy-step
1717               gnus-simplify-subject-fuzzy-regexp))
1718        (gnus-simplify-subject-fuzzy-regexp
1719         (gnus-simplify-buffer-fuzzy-step gnus-simplify-subject-fuzzy-regexp)))
1720       (gnus-simplify-buffer-fuzzy-step "^ *\\[[-+?*!][-+?*!]\\] *")
1721       (gnus-simplify-buffer-fuzzy-step
1722        "^ *\\(re\\|fw\\|fwd\\)[[{(^0-9]*[])}]?[:;] *")
1723       (gnus-simplify-buffer-fuzzy-step "^[[].*:\\( .*\\)[]]$" "\\1"))
1724
1725     (gnus-simplify-buffer-fuzzy-step " *[[{(][^()\n]*[]})] *$")
1726     (gnus-simplify-buffer-fuzzy-step "  +" " ")
1727     (gnus-simplify-buffer-fuzzy-step " $")
1728     (gnus-simplify-buffer-fuzzy-step "^ +")))
1729
1730 (defun gnus-simplify-subject-fuzzy (subject)
1731   "Simplify a subject string fuzzily.
1732 See `gnus-simplify-buffer-fuzzy' for details."
1733   (save-excursion
1734     (gnus-set-work-buffer)
1735     (let ((case-fold-search t))
1736       ;; Remove uninteresting prefixes.
1737       (when (and gnus-simplify-ignored-prefixes
1738                  (string-match gnus-simplify-ignored-prefixes subject))
1739         (setq subject (substring subject (match-end 0))))
1740       (insert subject)
1741       (inline (gnus-simplify-buffer-fuzzy))
1742       (buffer-string))))
1743
1744 (defsubst gnus-simplify-subject-fully (subject)
1745   "Simplify a subject string according to `gnus-summary-gather-subject-limit'."
1746   (cond
1747    (gnus-simplify-subject-functions
1748     (gnus-map-function gnus-simplify-subject-functions subject))
1749    ((null gnus-summary-gather-subject-limit)
1750     (gnus-simplify-subject-re subject))
1751    ((eq gnus-summary-gather-subject-limit 'fuzzy)
1752     (gnus-simplify-subject-fuzzy subject))
1753    ((numberp gnus-summary-gather-subject-limit)
1754     (truncate-string-to-width (gnus-simplify-subject-re subject)
1755                               gnus-summary-gather-subject-limit))
1756    (t
1757     subject)))
1758
1759 (defsubst gnus-subject-equal (s1 s2 &optional simple-first)
1760   "Check whether two subjects are equal.
1761 If optional argument SIMPLE-FIRST is t, first argument is already
1762 simplified."
1763   (cond
1764    ((null simple-first)
1765     (equal (gnus-simplify-subject-fully s1)
1766            (gnus-simplify-subject-fully s2)))
1767    (t
1768     (equal s1
1769            (gnus-simplify-subject-fully s2)))))
1770
1771 (defun gnus-summary-bubble-group ()
1772   "Increase the score of the current group.
1773 This is a handy function to add to `gnus-summary-exit-hook' to
1774 increase the score of each group you read."
1775   (gnus-group-add-score gnus-newsgroup-name))
1776
1777 \f
1778 ;;;
1779 ;;; Gnus summary mode
1780 ;;;
1781
1782 (put 'gnus-summary-mode 'mode-class 'special)
1783
1784 (defvar gnus-article-commands-menu)
1785
1786 ;; Non-orthogonal keys
1787
1788 (gnus-define-keys gnus-summary-mode-map
1789   " " gnus-summary-next-page
1790   "\177" gnus-summary-prev-page
1791   [delete] gnus-summary-prev-page
1792   [backspace] gnus-summary-prev-page
1793   "\r" gnus-summary-scroll-up
1794   "\M-\r" gnus-summary-scroll-down
1795   "n" gnus-summary-next-unread-article
1796   "p" gnus-summary-prev-unread-article
1797   "N" gnus-summary-next-article
1798   "P" gnus-summary-prev-article
1799   "\M-\C-n" gnus-summary-next-same-subject
1800   "\M-\C-p" gnus-summary-prev-same-subject
1801   "\M-n" gnus-summary-next-unread-subject
1802   "\M-p" gnus-summary-prev-unread-subject
1803   "." gnus-summary-first-unread-article
1804   "," gnus-summary-best-unread-article
1805   "\M-s" gnus-summary-search-article-forward
1806   "\M-r" gnus-summary-search-article-backward
1807   "\M-S" gnus-summary-repeat-search-article-forward
1808   "\M-R" gnus-summary-repeat-search-article-backward
1809   "<" gnus-summary-beginning-of-article
1810   ">" gnus-summary-end-of-article
1811   "j" gnus-summary-goto-article
1812   "^" gnus-summary-refer-parent-article
1813   "\M-^" gnus-summary-refer-article
1814   "u" gnus-summary-tick-article-forward
1815   "!" gnus-summary-tick-article-forward
1816   "U" gnus-summary-tick-article-backward
1817   "d" gnus-summary-mark-as-read-forward
1818   "D" gnus-summary-mark-as-read-backward
1819   "E" gnus-summary-mark-as-expirable
1820   "\M-u" gnus-summary-clear-mark-forward
1821   "\M-U" gnus-summary-clear-mark-backward
1822   "k" gnus-summary-kill-same-subject-and-select
1823   "\C-k" gnus-summary-kill-same-subject
1824   "\M-\C-k" gnus-summary-kill-thread
1825   "\M-\C-l" gnus-summary-lower-thread
1826   "e" gnus-summary-edit-article
1827   "#" gnus-summary-mark-as-processable
1828   "\M-#" gnus-summary-unmark-as-processable
1829   "\M-\C-t" gnus-summary-toggle-threads
1830   "\M-\C-s" gnus-summary-show-thread
1831   "\M-\C-h" gnus-summary-hide-thread
1832   "\M-\C-f" gnus-summary-next-thread
1833   "\M-\C-b" gnus-summary-prev-thread
1834   [(meta down)] gnus-summary-next-thread
1835   [(meta up)] gnus-summary-prev-thread
1836   "\M-\C-u" gnus-summary-up-thread
1837   "\M-\C-d" gnus-summary-down-thread
1838   "&" gnus-summary-execute-command
1839   "c" gnus-summary-catchup-and-exit
1840   "\C-w" gnus-summary-mark-region-as-read
1841   "\C-t" gnus-summary-toggle-truncation
1842   "?" gnus-summary-mark-as-dormant
1843   "\C-c\M-\C-s" gnus-summary-limit-include-expunged
1844   "\C-c\C-s\C-n" gnus-summary-sort-by-number
1845   "\C-c\C-s\C-m\C-n" gnus-summary-sort-by-most-recent-number
1846   "\C-c\C-s\C-l" gnus-summary-sort-by-lines
1847   "\C-c\C-s\C-c" gnus-summary-sort-by-chars
1848   "\C-c\C-s\C-a" gnus-summary-sort-by-author
1849   "\C-c\C-s\C-t" gnus-summary-sort-by-recipient
1850   "\C-c\C-s\C-s" gnus-summary-sort-by-subject
1851   "\C-c\C-s\C-d" gnus-summary-sort-by-date
1852   "\C-c\C-s\C-m\C-d" gnus-summary-sort-by-most-recent-date
1853   "\C-c\C-s\C-i" gnus-summary-sort-by-score
1854   "\C-c\C-s\C-o" gnus-summary-sort-by-original
1855   "\C-c\C-s\C-r" gnus-summary-sort-by-random
1856   "=" gnus-summary-expand-window
1857   "\C-x\C-s" gnus-summary-reselect-current-group
1858   "\M-g" gnus-summary-rescan-group
1859   "\C-c\C-r" gnus-summary-caesar-message
1860   "f" gnus-summary-followup
1861   "F" gnus-summary-followup-with-original
1862   "C" gnus-summary-cancel-article
1863   "r" gnus-summary-reply
1864   "R" gnus-summary-reply-with-original
1865   "\C-c\C-f" gnus-summary-mail-forward
1866   "o" gnus-summary-save-article
1867   "\C-o" gnus-summary-save-article-mail
1868   "|" gnus-summary-pipe-output
1869   "\M-k" gnus-summary-edit-local-kill
1870   "\M-K" gnus-summary-edit-global-kill
1871   ;; "V" gnus-version
1872   "\C-c\C-d" gnus-summary-describe-group
1873   "q" gnus-summary-exit
1874   "Q" gnus-summary-exit-no-update
1875   "\C-c\C-i" gnus-info-find-node
1876   gnus-mouse-2 gnus-mouse-pick-article
1877   [follow-link] mouse-face
1878   "m" gnus-summary-mail-other-window
1879   "a" gnus-summary-post-news
1880   "x" gnus-summary-limit-to-unread
1881   "s" gnus-summary-isearch-article
1882   "t" gnus-summary-toggle-header
1883   "g" gnus-summary-show-article
1884   "l" gnus-summary-goto-last-article
1885   "\C-c\C-v\C-v" gnus-uu-decode-uu-view
1886   "\C-d" gnus-summary-enter-digest-group
1887   "\M-\C-d" gnus-summary-read-document
1888   "\M-\C-e" gnus-summary-edit-parameters
1889   "\M-\C-a" gnus-summary-customize-parameters
1890   "\C-c\C-b" gnus-bug
1891   "*" gnus-cache-enter-article
1892   "\M-*" gnus-cache-remove-article
1893   "\M-&" gnus-summary-universal-argument
1894   "\C-l" gnus-recenter
1895   "I" gnus-summary-increase-score
1896   "L" gnus-summary-lower-score
1897   "\M-i" gnus-symbolic-argument
1898   "h" gnus-summary-select-article-buffer
1899
1900   "b" gnus-article-view-part
1901   "\M-t" gnus-summary-toggle-display-buttonized
1902
1903   "V" gnus-summary-score-map
1904   "X" gnus-uu-extract-map
1905   "S" gnus-summary-send-map)
1906
1907 ;; Sort of orthogonal keymap
1908 (gnus-define-keys (gnus-summary-mark-map "M" gnus-summary-mode-map)
1909   "t" gnus-summary-tick-article-forward
1910   "!" gnus-summary-tick-article-forward
1911   "d" gnus-summary-mark-as-read-forward
1912   "r" gnus-summary-mark-as-read-forward
1913   "c" gnus-summary-clear-mark-forward
1914   " " gnus-summary-clear-mark-forward
1915   "e" gnus-summary-mark-as-expirable
1916   "x" gnus-summary-mark-as-expirable
1917   "?" gnus-summary-mark-as-dormant
1918   "b" gnus-summary-set-bookmark
1919   "B" gnus-summary-remove-bookmark
1920   "#" gnus-summary-mark-as-processable
1921   "\M-#" gnus-summary-unmark-as-processable
1922   "S" gnus-summary-limit-include-expunged
1923   "C" gnus-summary-catchup
1924   "H" gnus-summary-catchup-to-here
1925   "h" gnus-summary-catchup-from-here
1926   "\C-c" gnus-summary-catchup-all
1927   "k" gnus-summary-kill-same-subject-and-select
1928   "K" gnus-summary-kill-same-subject
1929   "P" gnus-uu-mark-map)
1930
1931 (gnus-define-keys (gnus-summary-mscore-map "V" gnus-summary-mark-map)
1932   "c" gnus-summary-clear-above
1933   "u" gnus-summary-tick-above
1934   "m" gnus-summary-mark-above
1935   "k" gnus-summary-kill-below)
1936
1937 (gnus-define-keys (gnus-summary-limit-map "/" gnus-summary-mode-map)
1938   "/" gnus-summary-limit-to-subject
1939   "n" gnus-summary-limit-to-articles
1940   "b" gnus-summary-limit-to-bodies
1941   "h" gnus-summary-limit-to-headers
1942   "w" gnus-summary-pop-limit
1943   "s" gnus-summary-limit-to-subject
1944   "a" gnus-summary-limit-to-author
1945   "u" gnus-summary-limit-to-unread
1946   "m" gnus-summary-limit-to-marks
1947   "M" gnus-summary-limit-exclude-marks
1948   "v" gnus-summary-limit-to-score
1949   "*" gnus-summary-limit-include-cached
1950   "D" gnus-summary-limit-include-dormant
1951   "T" gnus-summary-limit-include-thread
1952   "d" gnus-summary-limit-exclude-dormant
1953   "t" gnus-summary-limit-to-age
1954   "." gnus-summary-limit-to-unseen
1955   "x" gnus-summary-limit-to-extra
1956   "p" gnus-summary-limit-to-display-predicate
1957   "E" gnus-summary-limit-include-expunged
1958   "c" gnus-summary-limit-exclude-childless-dormant
1959   "C" gnus-summary-limit-mark-excluded-as-read
1960   "o" gnus-summary-insert-old-articles
1961   "N" gnus-summary-insert-new-articles
1962   "S" gnus-summary-limit-to-singletons
1963   "r" gnus-summary-limit-to-replied
1964   "R" gnus-summary-limit-to-recipient
1965   "A" gnus-summary-limit-to-address)
1966
1967 (gnus-define-keys (gnus-summary-goto-map "G" gnus-summary-mode-map)
1968   "n" gnus-summary-next-unread-article
1969   "p" gnus-summary-prev-unread-article
1970   "N" gnus-summary-next-article
1971   "P" gnus-summary-prev-article
1972   "\C-n" gnus-summary-next-same-subject
1973   "\C-p" gnus-summary-prev-same-subject
1974   "\M-n" gnus-summary-next-unread-subject
1975   "\M-p" gnus-summary-prev-unread-subject
1976   "f" gnus-summary-first-unread-article
1977   "b" gnus-summary-best-unread-article
1978   "j" gnus-summary-goto-article
1979   "g" gnus-summary-goto-subject
1980   "l" gnus-summary-goto-last-article
1981   "o" gnus-summary-pop-article)
1982
1983 (gnus-define-keys (gnus-summary-thread-map "T" gnus-summary-mode-map)
1984   "k" gnus-summary-kill-thread
1985   "E" gnus-summary-expire-thread
1986   "l" gnus-summary-lower-thread
1987   "i" gnus-summary-raise-thread
1988   "T" gnus-summary-toggle-threads
1989   "t" gnus-summary-rethread-current
1990   "^" gnus-summary-reparent-thread
1991   "\M-^" gnus-summary-reparent-children
1992   "s" gnus-summary-show-thread
1993   "S" gnus-summary-show-all-threads
1994   "h" gnus-summary-hide-thread
1995   "H" gnus-summary-hide-all-threads
1996   "n" gnus-summary-next-thread
1997   "p" gnus-summary-prev-thread
1998   "u" gnus-summary-up-thread
1999   "o" gnus-summary-top-thread
2000   "d" gnus-summary-down-thread
2001   "#" gnus-uu-mark-thread
2002   "\M-#" gnus-uu-unmark-thread)
2003
2004 (gnus-define-keys (gnus-summary-buffer-map "Y" gnus-summary-mode-map)
2005   "g" gnus-summary-prepare
2006   "c" gnus-summary-insert-cached-articles
2007   "d" gnus-summary-insert-dormant-articles
2008   "t" gnus-summary-insert-ticked-articles)
2009
2010 (gnus-define-keys (gnus-summary-exit-map "Z" gnus-summary-mode-map)
2011   "c" gnus-summary-catchup-and-exit
2012   "C" gnus-summary-catchup-all-and-exit
2013   "E" gnus-summary-exit-no-update
2014   "Q" gnus-summary-exit
2015   "Z" gnus-summary-exit
2016   "n" gnus-summary-catchup-and-goto-next-group
2017   "p" gnus-summary-catchup-and-goto-prev-group
2018   "R" gnus-summary-reselect-current-group
2019   "G" gnus-summary-rescan-group
2020   "N" gnus-summary-next-group
2021   "s" gnus-summary-save-newsrc
2022   "P" gnus-summary-prev-group)
2023
2024 (gnus-define-keys (gnus-summary-article-map "A" gnus-summary-mode-map)
2025   " " gnus-summary-next-page
2026   "n" gnus-summary-next-page
2027   "\177" gnus-summary-prev-page
2028   [delete] gnus-summary-prev-page
2029   "p" gnus-summary-prev-page
2030   "\r" gnus-summary-scroll-up
2031   "\M-\r" gnus-summary-scroll-down
2032   "<" gnus-summary-beginning-of-article
2033   ">" gnus-summary-end-of-article
2034   "b" gnus-summary-beginning-of-article
2035   "e" gnus-summary-end-of-article
2036   "^" gnus-summary-refer-parent-article
2037   "r" gnus-summary-refer-parent-article
2038   "D" gnus-summary-enter-digest-group
2039   "R" gnus-summary-refer-references
2040   "T" gnus-summary-refer-thread
2041   "g" gnus-summary-show-article
2042   "s" gnus-summary-isearch-article
2043   "P" gnus-summary-print-article
2044   "S" gnus-sticky-article
2045   "M" gnus-mailing-list-insinuate
2046   "t" gnus-article-babel)
2047
2048 (gnus-define-keys (gnus-summary-wash-map "W" gnus-summary-mode-map)
2049   "b" gnus-article-add-buttons
2050   "B" gnus-article-add-buttons-to-head
2051   "o" gnus-article-treat-overstrike
2052   "e" gnus-article-emphasize
2053   "w" gnus-article-fill-cited-article
2054   "Q" gnus-article-fill-long-lines
2055   "L" gnus-article-toggle-truncate-lines
2056   "C" gnus-article-capitalize-sentences
2057   "c" gnus-article-remove-cr
2058   "q" gnus-article-de-quoted-unreadable
2059   "6" gnus-article-de-base64-unreadable
2060   "Z" gnus-article-decode-HZ
2061   "A" gnus-article-treat-ansi-sequences
2062   "h" gnus-article-wash-html
2063   "u" gnus-article-unsplit-urls
2064   "s" gnus-summary-force-verify-and-decrypt
2065   "f" gnus-article-display-x-face
2066   "l" gnus-summary-stop-page-breaking
2067   "r" gnus-summary-caesar-message
2068   "m" gnus-summary-morse-message
2069   "t" gnus-summary-toggle-header
2070   "g" gnus-treat-smiley
2071   "v" gnus-summary-verbose-headers
2072   "a" gnus-article-strip-headers-in-body ;; mnemonic: wash archive
2073   "p" gnus-article-verify-x-pgp-sig
2074   "d" gnus-article-treat-dumbquotes
2075   "i" gnus-summary-idna-message)
2076
2077 (gnus-define-keys (gnus-summary-wash-deuglify-map "Y" gnus-summary-wash-map)
2078   ;; mnemonic: deuglif*Y*
2079   "u" gnus-article-outlook-unwrap-lines
2080   "a" gnus-article-outlook-repair-attribution
2081   "c" gnus-article-outlook-rearrange-citation
2082   "f" gnus-article-outlook-deuglify-article) ;; mnemonic: full deuglify
2083
2084 (gnus-define-keys (gnus-summary-wash-hide-map "W" gnus-summary-wash-map)
2085   "a" gnus-article-hide
2086   "h" gnus-article-hide-headers
2087   "b" gnus-article-hide-boring-headers
2088   "s" gnus-article-hide-signature
2089   "c" gnus-article-hide-citation
2090   "C" gnus-article-hide-citation-in-followups
2091   "l" gnus-article-hide-list-identifiers
2092   "B" gnus-article-strip-banner
2093   "P" gnus-article-hide-pem
2094   "\C-c" gnus-article-hide-citation-maybe)
2095
2096 (gnus-define-keys (gnus-summary-wash-highlight-map "H" gnus-summary-wash-map)
2097   "a" gnus-article-highlight
2098   "h" gnus-article-highlight-headers
2099   "c" gnus-article-highlight-citation
2100   "s" gnus-article-highlight-signature)
2101
2102 (gnus-define-keys (gnus-summary-wash-header-map "G" gnus-summary-wash-map)
2103   "f" gnus-article-treat-fold-headers
2104   "u" gnus-article-treat-unfold-headers
2105   "n" gnus-article-treat-fold-newsgroups)
2106
2107 (gnus-define-keys (gnus-summary-wash-display-map "D" gnus-summary-wash-map)
2108   "x" gnus-article-display-x-face
2109   "d" gnus-article-display-face
2110   "s" gnus-treat-smiley
2111   "D" gnus-article-remove-images
2112   "W" gnus-html-show-images
2113   "f" gnus-treat-from-picon
2114   "m" gnus-treat-mail-picon
2115   "n" gnus-treat-newsgroups-picon)
2116
2117 (gnus-define-keys (gnus-summary-wash-mime-map "M" gnus-summary-wash-map)
2118   "w" gnus-article-decode-mime-words
2119   "c" gnus-article-decode-charset
2120   "v" gnus-mime-view-all-parts
2121   "b" gnus-article-view-part)
2122
2123 (gnus-define-keys (gnus-summary-wash-time-map "T" gnus-summary-wash-map)
2124   "z" gnus-article-date-ut
2125   "u" gnus-article-date-ut
2126   "l" gnus-article-date-local
2127   "p" gnus-article-date-english
2128   "e" gnus-article-date-lapsed
2129   "o" gnus-article-date-original
2130   "i" gnus-article-date-iso8601
2131   "s" gnus-article-date-user)
2132
2133 (gnus-define-keys (gnus-summary-wash-empty-map "E" gnus-summary-wash-map)
2134   "t" gnus-article-remove-trailing-blank-lines
2135   "l" gnus-article-strip-leading-blank-lines
2136   "m" gnus-article-strip-multiple-blank-lines
2137   "a" gnus-article-strip-blank-lines
2138   "A" gnus-article-strip-all-blank-lines
2139   "s" gnus-article-strip-leading-space
2140   "e" gnus-article-strip-trailing-space
2141   "w" gnus-article-remove-leading-whitespace)
2142
2143 (gnus-define-keys (gnus-summary-help-map "H" gnus-summary-mode-map)
2144   "v" gnus-version
2145   "f" gnus-summary-fetch-faq
2146   "d" gnus-summary-describe-group
2147   "h" gnus-summary-describe-briefly
2148   "i" gnus-info-find-node
2149   "c" gnus-group-fetch-charter
2150   "C" gnus-group-fetch-control)
2151
2152 (gnus-define-keys (gnus-summary-backend-map "B" gnus-summary-mode-map)
2153   "e" gnus-summary-expire-articles
2154   "\M-\C-e" gnus-summary-expire-articles-now
2155   "\177" gnus-summary-delete-article
2156   [delete] gnus-summary-delete-article
2157   [backspace] gnus-summary-delete-article
2158   "m" gnus-summary-move-article
2159   "r" gnus-summary-respool-article
2160   "w" gnus-summary-edit-article
2161   "c" gnus-summary-copy-article
2162   "B" gnus-summary-crosspost-article
2163   "q" gnus-summary-respool-query
2164   "t" gnus-summary-respool-trace
2165   "i" gnus-summary-import-article
2166   "I" gnus-summary-create-article
2167   "p" gnus-summary-article-posted-p)
2168
2169 (gnus-define-keys (gnus-summary-save-map "O" gnus-summary-mode-map)
2170   "o" gnus-summary-save-article
2171   "m" gnus-summary-save-article-mail
2172   "F" gnus-summary-write-article-file
2173   "r" gnus-summary-save-article-rmail
2174   "f" gnus-summary-save-article-file
2175   "b" gnus-summary-save-article-body-file
2176   "B" gnus-summary-write-article-body-file
2177   "h" gnus-summary-save-article-folder
2178   "v" gnus-summary-save-article-vm
2179   "p" gnus-summary-pipe-output
2180   "P" gnus-summary-muttprint)
2181
2182 (gnus-define-keys (gnus-summary-mime-map "K" gnus-summary-mode-map)
2183   "b" gnus-summary-display-buttonized
2184   "m" gnus-summary-repair-multipart
2185   "v" gnus-article-view-part
2186   "o" gnus-article-save-part
2187   "O" gnus-article-save-part-and-strip
2188   "r" gnus-article-replace-part
2189   "d" gnus-article-delete-part
2190   "t" gnus-article-view-part-as-type
2191   "j" gnus-article-jump-to-part
2192   "c" gnus-article-copy-part
2193   "C" gnus-article-view-part-as-charset
2194   "e" gnus-article-view-part-externally
2195   "H" gnus-article-browse-html-article
2196   "E" gnus-article-encrypt-body
2197   "i" gnus-article-inline-part
2198   "|" gnus-article-pipe-part)
2199
2200 (gnus-define-keys (gnus-uu-mark-map "P" gnus-summary-mark-map)
2201   "p" gnus-summary-mark-as-processable
2202   "u" gnus-summary-unmark-as-processable
2203   "U" gnus-summary-unmark-all-processable
2204   "v" gnus-uu-mark-over
2205   "s" gnus-uu-mark-series
2206   "r" gnus-uu-mark-region
2207   "g" gnus-uu-unmark-region
2208   "R" gnus-uu-mark-by-regexp
2209   "G" gnus-uu-unmark-by-regexp
2210   "t" gnus-uu-mark-thread
2211   "T" gnus-uu-unmark-thread
2212   "a" gnus-uu-mark-all
2213   "b" gnus-uu-mark-buffer
2214   "S" gnus-uu-mark-sparse
2215   "k" gnus-summary-kill-process-mark
2216   "y" gnus-summary-yank-process-mark
2217   "w" gnus-summary-save-process-mark
2218   "i" gnus-uu-invert-processable)
2219
2220 (gnus-define-keys (gnus-uu-extract-map "X" gnus-summary-mode-map)
2221   ;;"x" gnus-uu-extract-any
2222   "m" gnus-summary-save-parts
2223   "u" gnus-uu-decode-uu
2224   "U" gnus-uu-decode-uu-and-save
2225   "s" gnus-uu-decode-unshar
2226   "S" gnus-uu-decode-unshar-and-save
2227   "o" gnus-uu-decode-save
2228   "O" gnus-uu-decode-save
2229   "b" gnus-uu-decode-binhex
2230   "B" gnus-uu-decode-binhex
2231   "Y" gnus-uu-decode-yenc
2232   "p" gnus-uu-decode-postscript
2233   "P" gnus-uu-decode-postscript-and-save)
2234
2235 (gnus-define-keys
2236     (gnus-uu-extract-view-map "v" gnus-uu-extract-map)
2237   "u" gnus-uu-decode-uu-view
2238   "U" gnus-uu-decode-uu-and-save-view
2239   "s" gnus-uu-decode-unshar-view
2240   "S" gnus-uu-decode-unshar-and-save-view
2241   "o" gnus-uu-decode-save-view
2242   "O" gnus-uu-decode-save-view
2243   "b" gnus-uu-decode-binhex-view
2244   "B" gnus-uu-decode-binhex-view
2245   "p" gnus-uu-decode-postscript-view
2246   "P" gnus-uu-decode-postscript-and-save-view)
2247
2248 (defvar gnus-article-post-menu nil)
2249
2250 (defconst gnus-summary-menu-maxlen 20)
2251
2252 (defun gnus-summary-menu-split (menu)
2253   ;; If we have lots of elements, divide them into groups of 20
2254   ;; and make a pane (or submenu) for each one.
2255   (if (> (length menu) (/ (* gnus-summary-menu-maxlen 3) 2))
2256       (let ((menu menu) sublists next
2257             (i 1))
2258         (while menu
2259           ;; Pull off the next gnus-summary-menu-maxlen elements
2260           ;; and make them the next element of sublist.
2261           (setq next (nthcdr gnus-summary-menu-maxlen menu))
2262           (if next
2263               (setcdr (nthcdr (1- gnus-summary-menu-maxlen) menu)
2264                       nil))
2265           (setq sublists (cons (cons (format "%s ... %s" (aref (car menu) 0)
2266                                              (aref (car (last menu)) 0)) menu)
2267                                sublists))
2268           (setq i (1+ i))
2269           (setq menu next))
2270         (nreverse sublists))
2271     ;; Few elements--put them all in one pane.
2272     menu))
2273
2274 (defun gnus-summary-make-menu-bar ()
2275   (gnus-turn-off-edit-menu 'summary)
2276
2277   (unless (boundp 'gnus-summary-misc-menu)
2278
2279     (easy-menu-define
2280       gnus-summary-kill-menu gnus-summary-mode-map ""
2281       (cons
2282        "Score"
2283        (nconc
2284         (list
2285          ["Customize" gnus-score-customize t])
2286         (gnus-make-score-map 'increase)
2287         (gnus-make-score-map 'lower)
2288         '(("Mark"
2289            ["Kill below" gnus-summary-kill-below t]
2290            ["Mark above" gnus-summary-mark-above t]
2291            ["Tick above" gnus-summary-tick-above t]
2292            ["Clear above" gnus-summary-clear-above t])
2293           ["Current score" gnus-summary-current-score t]
2294           ["Set score" gnus-summary-set-score t]
2295           ["Switch current score file..." gnus-score-change-score-file t]
2296           ["Set mark below..." gnus-score-set-mark-below t]
2297           ["Set expunge below..." gnus-score-set-expunge-below t]
2298           ["Edit current score file" gnus-score-edit-current-scores t]
2299           ["Edit score file..." gnus-score-edit-file t]
2300           ["Trace score" gnus-score-find-trace t]
2301           ["Find words" gnus-score-find-favourite-words t]
2302           ["Rescore buffer" gnus-summary-rescore t]
2303           ["Increase score..." gnus-summary-increase-score t]
2304           ["Lower score..." gnus-summary-lower-score t]))))
2305
2306     ;; Define both the Article menu in the summary buffer and the
2307     ;; equivalent Commands menu in the article buffer here for
2308     ;; consistency.
2309     (let ((innards
2310            `(("Hide"
2311               ["All" gnus-article-hide t]
2312               ["Headers" gnus-article-hide-headers t]
2313               ["Signature" gnus-article-hide-signature t]
2314               ["Citation" gnus-article-hide-citation t]
2315               ["List identifiers" gnus-article-hide-list-identifiers t]
2316               ["Banner" gnus-article-strip-banner t]
2317               ["Boring headers" gnus-article-hide-boring-headers t])
2318              ("Highlight"
2319               ["All" gnus-article-highlight t]
2320               ["Headers" gnus-article-highlight-headers t]
2321               ["Signature" gnus-article-highlight-signature t]
2322               ["Citation" gnus-article-highlight-citation t])
2323              ("MIME"
2324               ["Words" gnus-article-decode-mime-words t]
2325               ["Charset" gnus-article-decode-charset t]
2326               ["QP" gnus-article-de-quoted-unreadable t]
2327               ["Base64" gnus-article-de-base64-unreadable t]
2328               ["View MIME buttons" gnus-summary-display-buttonized t]
2329               ["View all" gnus-mime-view-all-parts t]
2330               ["Verify and Decrypt" gnus-summary-force-verify-and-decrypt t]
2331               ["Encrypt body" gnus-article-encrypt-body
2332                :active (not (gnus-group-read-only-p))
2333                ,@(if (featurep 'xemacs) nil
2334                    '(:help "Encrypt the message body on disk"))]
2335               ["Extract all parts..." gnus-summary-save-parts t]
2336               ("Multipart"
2337                ["Repair multipart" gnus-summary-repair-multipart t]
2338                ["Pipe part..." gnus-article-pipe-part t]
2339                ["Inline part" gnus-article-inline-part t]
2340                ["View part as type..." gnus-article-view-part-as-type t]
2341                ["Encrypt body" gnus-article-encrypt-body
2342                 :active (not (gnus-group-read-only-p))
2343                ,@(if (featurep 'xemacs) nil
2344                    '(:help "Encrypt the message body on disk"))]
2345                ["View part externally" gnus-article-view-part-externally t]
2346                ["View HTML parts in browser" gnus-article-browse-html-article t]
2347                ["View part with charset..." gnus-article-view-part-as-charset t]
2348                ["Copy part" gnus-article-copy-part t]
2349                ["Save part..." gnus-article-save-part t]
2350                ["View part" gnus-article-view-part t]))
2351              ("Date"
2352               ["Local" gnus-article-date-local t]
2353               ["ISO8601" gnus-article-date-iso8601 t]
2354               ["UT" gnus-article-date-ut t]
2355               ["Original" gnus-article-date-original t]
2356               ["Lapsed" gnus-article-date-lapsed t]
2357               ["User-defined" gnus-article-date-user t])
2358              ("Display"
2359               ["Remove images" gnus-article-remove-images t]
2360               ["Toggle smiley" gnus-treat-smiley t]
2361               ["Show X-Face" gnus-article-display-x-face t]
2362               ["Show picons in From" gnus-treat-from-picon t]
2363               ["Show picons in mail headers" gnus-treat-mail-picon t]
2364               ["Show picons in news headers" gnus-treat-newsgroups-picon t]
2365               ("View as different encoding"
2366                ,@(gnus-summary-menu-split
2367                   (mapcar
2368                    (lambda (cs)
2369                      ;; Since easymenu under Emacs doesn't allow
2370                      ;; lambda forms for menu commands, we should
2371                      ;; provide intern'ed function symbols.
2372                      (let ((command (intern (format "\
2373 gnus-summary-show-article-from-menu-as-charset-%s" cs))))
2374                        (fset command
2375                              `(lambda ()
2376                                 (interactive)
2377                                 (let ((gnus-summary-show-article-charset-alist
2378                                        '((1 . ,cs))))
2379                                   (gnus-summary-show-article 1))))
2380                        `[,(symbol-name cs) ,command t]))
2381                    (sort (if (fboundp 'coding-system-list)
2382                              (coding-system-list)
2383                            (mapcar 'car mm-mime-mule-charset-alist))
2384                          'string<)))))
2385              ("Washing"
2386               ("Remove Blanks"
2387                ["Leading" gnus-article-strip-leading-blank-lines t]
2388                ["Multiple" gnus-article-strip-multiple-blank-lines t]
2389                ["Trailing" gnus-article-remove-trailing-blank-lines t]
2390                ["All of the above" gnus-article-strip-blank-lines t]
2391                ["All" gnus-article-strip-all-blank-lines t]
2392                ["Leading space" gnus-article-strip-leading-space t]
2393                ["Trailing space" gnus-article-strip-trailing-space t]
2394                ["Leading space in headers"
2395                 gnus-article-remove-leading-whitespace t])
2396               ["Overstrike" gnus-article-treat-overstrike t]
2397               ["Dumb quotes" gnus-article-treat-dumbquotes t]
2398               ["Emphasis" gnus-article-emphasize t]
2399               ["Word wrap" gnus-article-fill-cited-article t]
2400               ["Fill long lines" gnus-article-fill-long-lines t]
2401               ["Toggle truncate long lines" gnus-article-toggle-truncate-lines t]
2402               ["Capitalize sentences" gnus-article-capitalize-sentences t]
2403               ["Remove CR" gnus-article-remove-cr t]
2404               ["Quoted-Printable" gnus-article-de-quoted-unreadable t]
2405               ["Base64" gnus-article-de-base64-unreadable t]
2406               ["Rot 13" gnus-summary-caesar-message
2407                ,@(if (featurep 'xemacs) '(t)
2408                    '(:help "\"Caesar rotate\" article by 13"))]
2409               ["De-IDNA" gnus-summary-idna-message t]
2410               ["Morse decode" gnus-summary-morse-message t]
2411               ["Unix pipe..." gnus-summary-pipe-message t]
2412               ["Add buttons" gnus-article-add-buttons t]
2413               ["Add buttons to head" gnus-article-add-buttons-to-head t]
2414               ["Stop page breaking" gnus-summary-stop-page-breaking t]
2415               ["Verbose header" gnus-summary-verbose-headers t]
2416               ["Toggle header" gnus-summary-toggle-header t]
2417               ["Unfold headers" gnus-article-treat-unfold-headers t]
2418               ["Fold newsgroups" gnus-article-treat-fold-newsgroups t]
2419               ["Html" gnus-article-wash-html t]
2420               ["Unsplit URLs" gnus-article-unsplit-urls t]
2421               ["Verify X-PGP-Sig" gnus-article-verify-x-pgp-sig t]
2422               ["Decode HZ" gnus-article-decode-HZ t]
2423               ["ANSI sequences" gnus-article-treat-ansi-sequences t]
2424               ("(Outlook) Deuglify"
2425                ["Unwrap lines" gnus-article-outlook-unwrap-lines t]
2426                ["Repair attribution" gnus-article-outlook-repair-attribution t]
2427                ["Rearrange citation" gnus-article-outlook-rearrange-citation t]
2428                ["Full (Outlook) deuglify"
2429                 gnus-article-outlook-deuglify-article t])
2430               )
2431              ("Output"
2432               ["Save in default format..." gnus-summary-save-article
2433                ,@(if (featurep 'xemacs) '(t)
2434                    '(:help "Save article using default method"))]
2435               ["Save in file..." gnus-summary-save-article-file
2436                ,@(if (featurep 'xemacs) '(t)
2437                    '(:help "Save article in file"))]
2438               ["Save in Unix mail format..." gnus-summary-save-article-mail t]
2439               ["Save in MH folder..." gnus-summary-save-article-folder t]
2440               ["Save in VM folder..." gnus-summary-save-article-vm t]
2441               ["Save in RMAIL mbox..." gnus-summary-save-article-rmail t]
2442               ["Save body in file..." gnus-summary-save-article-body-file t]
2443               ["Pipe through a filter..." gnus-summary-pipe-output t]
2444               ["Print with Muttprint..." gnus-summary-muttprint t]
2445               ["Print" gnus-summary-print-article
2446                ,@(if (featurep 'xemacs) '(t)
2447                    '(:help "Generate and print a PostScript image"))])
2448              ("Copy, move,... (Backend)"
2449               ,@(if (featurep 'xemacs) nil
2450                   '(:help "Copying, moving, expiring articles..."))
2451               ["Respool article..." gnus-summary-respool-article t]
2452               ["Move article..." gnus-summary-move-article
2453                (gnus-check-backend-function
2454                 'request-move-article gnus-newsgroup-name)]
2455               ["Copy article..." gnus-summary-copy-article t]
2456               ["Crosspost article..." gnus-summary-crosspost-article
2457                (gnus-check-backend-function
2458                 'request-replace-article gnus-newsgroup-name)]
2459               ["Import file..." gnus-summary-import-article
2460                (gnus-check-backend-function
2461                 'request-accept-article gnus-newsgroup-name)]
2462               ["Create article..." gnus-summary-create-article
2463                (gnus-check-backend-function
2464                 'request-accept-article gnus-newsgroup-name)]
2465               ["Check if posted" gnus-summary-article-posted-p t]
2466               ["Edit article" gnus-summary-edit-article
2467                (not (gnus-group-read-only-p))]
2468               ["Delete article" gnus-summary-delete-article
2469                (gnus-check-backend-function
2470                 'request-expire-articles gnus-newsgroup-name)]
2471               ["Query respool" gnus-summary-respool-query t]
2472               ["Trace respool" gnus-summary-respool-trace t]
2473               ["Delete expirable articles" gnus-summary-expire-articles-now
2474                (gnus-check-backend-function
2475                 'request-expire-articles gnus-newsgroup-name)])
2476              ("Extract"
2477               ["Uudecode" gnus-uu-decode-uu
2478                ,@(if (featurep 'xemacs) '(t)
2479                    '(:help "Decode uuencoded article(s)"))]
2480               ["Uudecode and save" gnus-uu-decode-uu-and-save t]
2481               ["Unshar" gnus-uu-decode-unshar t]
2482               ["Unshar and save" gnus-uu-decode-unshar-and-save t]
2483               ["Save" gnus-uu-decode-save t]
2484               ["Binhex" gnus-uu-decode-binhex t]
2485               ["Postscript" gnus-uu-decode-postscript t]
2486               ["All MIME parts" gnus-summary-save-parts t])
2487              ("Cache"
2488               ["Enter article" gnus-cache-enter-article t]
2489               ["Remove article" gnus-cache-remove-article t])
2490              ["Translate" gnus-article-babel t]
2491              ["Select article buffer" gnus-summary-select-article-buffer t]
2492              ["Make article buffer sticky" gnus-sticky-article t]
2493              ["Enter digest buffer" gnus-summary-enter-digest-group t]
2494              ["Isearch article..." gnus-summary-isearch-article t]
2495              ["Beginning of the article" gnus-summary-beginning-of-article t]
2496              ["End of the article" gnus-summary-end-of-article t]
2497              ["Fetch parent of article" gnus-summary-refer-parent-article t]
2498              ["Fetch referenced articles" gnus-summary-refer-references t]
2499              ["Fetch current thread" gnus-summary-refer-thread t]
2500              ["Fetch article with id..." gnus-summary-refer-article t]
2501              ["Setup Mailing List Params" gnus-mailing-list-insinuate t]
2502              ["Redisplay" gnus-summary-show-article t]
2503              ["Raw article" gnus-summary-show-raw-article :keys "C-u g"])))
2504       (easy-menu-define
2505         gnus-summary-article-menu gnus-summary-mode-map ""
2506         (cons "Article" innards))
2507
2508       (if (not (keymapp gnus-summary-article-menu))
2509           (easy-menu-define
2510             gnus-article-commands-menu gnus-article-mode-map ""
2511             (cons "Commands" innards))
2512         ;; in Emacs, don't share menu.
2513         (setq gnus-article-commands-menu
2514               (copy-keymap gnus-summary-article-menu))
2515         (define-key gnus-article-mode-map [menu-bar commands]
2516           (cons "Commands" gnus-article-commands-menu))))
2517
2518     (easy-menu-define
2519       gnus-summary-thread-menu gnus-summary-mode-map ""
2520       '("Threads"
2521         ["Find all messages in thread" gnus-summary-refer-thread t]
2522         ["Toggle threading" gnus-summary-toggle-threads t]
2523         ["Hide threads" gnus-summary-hide-all-threads t]
2524         ["Show threads" gnus-summary-show-all-threads t]
2525         ["Hide thread" gnus-summary-hide-thread t]
2526         ["Show thread" gnus-summary-show-thread t]
2527         ["Go to next thread" gnus-summary-next-thread t]
2528         ["Go to previous thread" gnus-summary-prev-thread t]
2529         ["Go down thread" gnus-summary-down-thread t]
2530         ["Go up thread" gnus-summary-up-thread t]
2531         ["Top of thread" gnus-summary-top-thread t]
2532         ["Mark thread as read" gnus-summary-kill-thread t]
2533         ["Mark thread as expired" gnus-summary-expire-thread t]
2534         ["Lower thread score" gnus-summary-lower-thread t]
2535         ["Raise thread score" gnus-summary-raise-thread t]
2536         ["Rethread current" gnus-summary-rethread-current t]))
2537
2538     (easy-menu-define
2539       gnus-summary-post-menu gnus-summary-mode-map ""
2540       `("Post"
2541         ["Send a message (mail or news)" gnus-summary-post-news
2542          ,@(if (featurep 'xemacs) '(t)
2543              '(:help "Compose a new message (mail or news)"))]
2544         ["Followup" gnus-summary-followup
2545          ,@(if (featurep 'xemacs) '(t)
2546              '(:help "Post followup to this article"))]
2547         ["Followup and yank" gnus-summary-followup-with-original
2548          ,@(if (featurep 'xemacs) '(t)
2549              '(:help "Post followup to this article, quoting its contents"))]
2550         ["Supersede article" gnus-summary-supersede-article t]
2551         ["Cancel article" gnus-summary-cancel-article
2552          ,@(if (featurep 'xemacs) '(t)
2553              '(:help "Cancel an article you posted"))]
2554         ["Reply" gnus-summary-reply t]
2555         ["Reply and yank" gnus-summary-reply-with-original t]
2556         ["Wide reply" gnus-summary-wide-reply t]
2557         ["Wide reply and yank" gnus-summary-wide-reply-with-original
2558          ,@(if (featurep 'xemacs) '(t)
2559              '(:help "Mail a reply, quoting this article"))]
2560         ["Very wide reply" gnus-summary-very-wide-reply t]
2561         ["Very wide reply and yank" gnus-summary-very-wide-reply-with-original
2562          ,@(if (featurep 'xemacs) '(t)
2563              '(:help "Mail a very wide reply, quoting this article"))]
2564         ["Mail forward" gnus-summary-mail-forward t]
2565         ["Post forward" gnus-summary-post-forward t]
2566         ["Digest and mail" gnus-uu-digest-mail-forward t]
2567         ["Digest and post" gnus-uu-digest-post-forward t]
2568         ["Resend message" gnus-summary-resend-message t]
2569         ["Resend message edit" gnus-summary-resend-message-edit t]
2570         ["Send bounced mail" gnus-summary-resend-bounced-mail t]
2571         ["Send a mail" gnus-summary-mail-other-window t]
2572         ["Create a local message" gnus-summary-news-other-window t]
2573         ["Uuencode and post" gnus-uu-post-news
2574          ,@(if (featurep 'xemacs) '(t)
2575              '(:help "Post a uuencoded article"))]
2576         ["Followup via news" gnus-summary-followup-to-mail t]
2577         ["Followup via news and yank"
2578          gnus-summary-followup-to-mail-with-original t]
2579         ["Strip signature on reply"
2580          (lambda ()
2581            (interactive)
2582            (if (not (memq message-cite-function
2583                           '(message-cite-original-without-signature
2584                             message-cite-original)))
2585                ;; Stupid workaround for XEmacs not honoring :visible.
2586                (message "Can't toggle this value of `message-cite-function'")
2587              (setq message-cite-function
2588                    (if (eq message-cite-function
2589                            'message-cite-original-without-signature)
2590                        'message-cite-original
2591                      'message-cite-original-without-signature))))
2592          ;; XEmacs barfs on :visible.
2593          ,@(if (featurep 'xemacs) nil
2594              '(:visible (memq message-cite-function
2595                               '(message-cite-original-without-signature
2596                                 message-cite-original))))
2597          :style toggle
2598          :selected (eq message-cite-function
2599                        'message-cite-original-without-signature)
2600          ,@(if (featurep 'xemacs) nil
2601              '(:help "Strip signature from cited article when replying."))]
2602         ;;("Draft"
2603         ;;["Send" gnus-summary-send-draft t]
2604         ;;["Send bounced" gnus-resend-bounced-mail t])
2605         ))
2606
2607     (cond
2608      ((not (keymapp gnus-summary-post-menu))
2609       (setq gnus-article-post-menu gnus-summary-post-menu))
2610      ((not gnus-article-post-menu)
2611       ;; Don't share post menu.
2612       (setq gnus-article-post-menu
2613             (copy-keymap gnus-summary-post-menu))))
2614     (define-key gnus-article-mode-map [menu-bar post]
2615       (cons "Post" gnus-article-post-menu))
2616
2617     (easy-menu-define
2618       gnus-summary-misc-menu gnus-summary-mode-map ""
2619       `("Gnus"
2620         ("Mark Read"
2621          ["Mark as read" gnus-summary-mark-as-read-forward t]
2622          ["Mark same subject and select"
2623           gnus-summary-kill-same-subject-and-select t]
2624          ["Mark same subject" gnus-summary-kill-same-subject t]
2625          ["Catchup" gnus-summary-catchup
2626           ,@(if (featurep 'xemacs) '(t)
2627               '(:help "Mark unread articles in this group as read"))]
2628          ["Catchup all" gnus-summary-catchup-all t]
2629          ["Catchup to here" gnus-summary-catchup-to-here t]
2630          ["Catchup from here" gnus-summary-catchup-from-here t]
2631          ["Catchup region" gnus-summary-mark-region-as-read
2632           (gnus-mark-active-p)]
2633          ["Mark excluded" gnus-summary-limit-mark-excluded-as-read t])
2634         ("Mark Various"
2635          ["Tick" gnus-summary-tick-article-forward t]
2636          ["Mark as dormant" gnus-summary-mark-as-dormant t]
2637          ["Remove marks" gnus-summary-clear-mark-forward t]
2638          ["Set expirable mark" gnus-summary-mark-as-expirable t]
2639          ["Set bookmark" gnus-summary-set-bookmark t]
2640          ["Remove bookmark" gnus-summary-remove-bookmark t])
2641         ("Limit to"
2642          ["Marks..." gnus-summary-limit-to-marks t]
2643          ["Subject..." gnus-summary-limit-to-subject t]
2644          ["Author..." gnus-summary-limit-to-author t]
2645          ["Recipient..." gnus-summary-limit-to-recipient t]
2646          ["Address..." gnus-summary-limit-to-address t]
2647          ["Age..." gnus-summary-limit-to-age t]
2648          ["Extra..." gnus-summary-limit-to-extra t]
2649          ["Score..." gnus-summary-limit-to-score t]
2650          ["Display Predicate" gnus-summary-limit-to-display-predicate t]
2651          ["Unread" gnus-summary-limit-to-unread t]
2652          ["Unseen" gnus-summary-limit-to-unseen t]
2653          ["Singletons" gnus-summary-limit-to-singletons t]
2654          ["Replied" gnus-summary-limit-to-replied t]
2655          ["Non-dormant" gnus-summary-limit-exclude-dormant t]
2656          ["Next or process marked articles" gnus-summary-limit-to-articles t]
2657          ["Pop limit" gnus-summary-pop-limit t]
2658          ["Show dormant" gnus-summary-limit-include-dormant t]
2659          ["Hide childless dormant"
2660           gnus-summary-limit-exclude-childless-dormant t]
2661          ;;["Hide thread" gnus-summary-limit-exclude-thread t]
2662          ["Hide marked" gnus-summary-limit-exclude-marks t]
2663          ["Show expunged" gnus-summary-limit-include-expunged t])
2664         ("Process Mark"
2665          ["Set mark" gnus-summary-mark-as-processable t]
2666          ["Remove mark" gnus-summary-unmark-as-processable t]
2667          ["Remove all marks" gnus-summary-unmark-all-processable t]
2668          ["Invert marks" gnus-uu-invert-processable t]
2669          ["Mark above" gnus-uu-mark-over t]
2670          ["Mark series" gnus-uu-mark-series t]
2671          ["Mark region" gnus-uu-mark-region (gnus-mark-active-p)]
2672          ["Unmark region" gnus-uu-unmark-region (gnus-mark-active-p)]
2673          ["Mark by regexp..." gnus-uu-mark-by-regexp t]
2674          ["Unmark by regexp..." gnus-uu-unmark-by-regexp t]
2675          ["Mark all" gnus-uu-mark-all t]
2676          ["Mark buffer" gnus-uu-mark-buffer t]
2677          ["Mark sparse" gnus-uu-mark-sparse t]
2678          ["Mark thread" gnus-uu-mark-thread t]
2679          ["Unmark thread" gnus-uu-unmark-thread t]
2680          ("Process Mark Sets"
2681           ["Kill" gnus-summary-kill-process-mark t]
2682           ["Yank" gnus-summary-yank-process-mark
2683            gnus-newsgroup-process-stack]
2684           ["Save" gnus-summary-save-process-mark t]
2685           ["Run command on marked..." gnus-summary-universal-argument t]))
2686         ("Registry Marks")
2687         ("Scroll article"
2688          ["Page forward" gnus-summary-next-page
2689           ,@(if (featurep 'xemacs) '(t)
2690               '(:help "Show next page of article"))]
2691          ["Page backward" gnus-summary-prev-page
2692           ,@(if (featurep 'xemacs) '(t)
2693               '(:help "Show previous page of article"))]
2694          ["Line forward" gnus-summary-scroll-up t])
2695         ("Move"
2696          ["Next unread article" gnus-summary-next-unread-article t]
2697          ["Previous unread article" gnus-summary-prev-unread-article t]
2698          ["Next article" gnus-summary-next-article t]
2699          ["Previous article" gnus-summary-prev-article t]
2700          ["Next unread subject" gnus-summary-next-unread-subject t]
2701          ["Previous unread subject" gnus-summary-prev-unread-subject t]
2702          ["Next article same subject" gnus-summary-next-same-subject t]
2703          ["Previous article same subject" gnus-summary-prev-same-subject t]
2704          ["First unread article" gnus-summary-first-unread-article t]
2705          ["Best unread article" gnus-summary-best-unread-article t]
2706          ["Go to subject number..." gnus-summary-goto-subject t]
2707          ["Go to article number..." gnus-summary-goto-article t]
2708          ["Go to the last article" gnus-summary-goto-last-article t]
2709          ["Pop article off history" gnus-summary-pop-article t])
2710         ("Sort"
2711          ["Sort by number" gnus-summary-sort-by-number t]
2712          ["Sort by most recent number" gnus-summary-sort-by-most-recent-number t]
2713          ["Sort by author" gnus-summary-sort-by-author t]
2714          ["Sort by recipient" gnus-summary-sort-by-recipient t]
2715          ["Sort by subject" gnus-summary-sort-by-subject t]
2716          ["Sort by date" gnus-summary-sort-by-date t]
2717          ["Sort by most recent date" gnus-summary-sort-by-most-recent-date t]
2718          ["Sort by score" gnus-summary-sort-by-score t]
2719          ["Sort by lines" gnus-summary-sort-by-lines t]
2720          ["Sort by characters" gnus-summary-sort-by-chars t]
2721          ["Randomize" gnus-summary-sort-by-random t]
2722          ["Original sort" gnus-summary-sort-by-original t])
2723         ("Help"
2724          ["Fetch group FAQ" gnus-summary-fetch-faq t]
2725          ["Describe group" gnus-summary-describe-group t]
2726          ["Fetch charter" gnus-group-fetch-charter
2727           ,@(if (featurep 'xemacs) nil
2728               '(:help "Display the charter of the current group"))]
2729          ["Fetch control message" gnus-group-fetch-control
2730           ,@(if (featurep 'xemacs) nil
2731               '(:help "Display the archived control message for the current group"))]
2732          ["Read manual" gnus-info-find-node t])
2733         ("Modes"
2734          ["Pick and read" gnus-pick-mode t]
2735          ["Binary" gnus-binary-mode t])
2736         ("Regeneration"
2737          ["Regenerate" gnus-summary-prepare t]
2738          ["Insert cached articles" gnus-summary-insert-cached-articles t]
2739          ["Insert dormant articles" gnus-summary-insert-dormant-articles t]
2740          ["Insert ticked articles" gnus-summary-insert-ticked-articles t]
2741          ["Toggle threading" gnus-summary-toggle-threads t])
2742         ["See old articles" gnus-summary-insert-old-articles t]
2743         ["See new articles" gnus-summary-insert-new-articles t]
2744         ["Filter articles..." gnus-summary-execute-command t]
2745         ["Run command on articles..." gnus-summary-universal-argument t]
2746         ["Search articles forward..." gnus-summary-search-article-forward t]
2747         ["Search articles backward..." gnus-summary-search-article-backward t]
2748         ["Toggle line truncation" gnus-summary-toggle-truncation t]
2749         ["Expand window" gnus-summary-expand-window t]
2750         ["Expire expirable articles" gnus-summary-expire-articles
2751          (gnus-check-backend-function
2752           'request-expire-articles gnus-newsgroup-name)]
2753         ["Edit local kill file" gnus-summary-edit-local-kill t]
2754         ["Edit main kill file" gnus-summary-edit-global-kill t]
2755         ["Edit group parameters" gnus-summary-edit-parameters t]
2756         ["Customize group parameters" gnus-summary-customize-parameters t]
2757         ["Send a bug report" gnus-bug t]
2758         ("Exit"
2759          ["Catchup and exit" gnus-summary-catchup-and-exit
2760           ,@(if (featurep 'xemacs) '(t)
2761               '(:help "Mark unread articles in this group as read, then exit"))]
2762          ["Catchup all and exit" gnus-summary-catchup-all-and-exit t]
2763          ["Catchup and goto next" gnus-summary-catchup-and-goto-next-group t]
2764          ["Catchup and goto prev" gnus-summary-catchup-and-goto-prev-group t]
2765          ["Exit group" gnus-summary-exit
2766           ,@(if (featurep 'xemacs) '(t)
2767               '(:help "Exit current group, return to group selection mode"))]
2768          ["Exit group without updating" gnus-summary-exit-no-update t]
2769          ["Exit and goto next group" gnus-summary-next-group t]
2770          ["Exit and goto prev group" gnus-summary-prev-group t]
2771          ["Reselect group" gnus-summary-reselect-current-group t]
2772          ["Rescan group" gnus-summary-rescan-group t]
2773          ["Update dribble" gnus-summary-save-newsrc t])))
2774
2775     (gnus-run-hooks 'gnus-summary-menu-hook)))
2776
2777 (defvar gnus-summary-tool-bar-map nil)
2778
2779 ;; Note: The :set function in the `gnus-summary-tool-bar*' variables will only
2780 ;; affect _new_ message buffers.  We might add a function that walks thru all
2781 ;; summary-mode buffers and force the update.
2782 (defun gnus-summary-tool-bar-update (&optional symbol value)
2783   "Update summary mode toolbar.
2784 Setter function for custom variables."
2785   (setq-default gnus-summary-tool-bar-map nil)
2786   (when symbol
2787     ;; When used as ":set" function:
2788     (set-default symbol value))
2789   (when (gnus-buffer-live-p gnus-summary-buffer)
2790     (with-current-buffer gnus-summary-buffer
2791       (gnus-summary-make-tool-bar))))
2792
2793 (defcustom gnus-summary-tool-bar (if (eq gmm-tool-bar-style 'gnome)
2794                                      'gnus-summary-tool-bar-gnome
2795                                    'gnus-summary-tool-bar-retro)
2796   "Specifies the Gnus summary tool bar.
2797
2798 It can be either a list or a symbol refering to a list.  See
2799 `gmm-tool-bar-from-list' for the format of the list.  The
2800 default key map is `gnus-summary-mode-map'.
2801
2802 Pre-defined symbols include `gnus-summary-tool-bar-gnome' and
2803 `gnus-summary-tool-bar-retro'."
2804   :type '(choice (const :tag "GNOME style" gnus-summary-tool-bar-gnome)
2805                  (const :tag "Retro look"  gnus-summary-tool-bar-retro)
2806                  (repeat :tag "User defined list" gmm-tool-bar-item)
2807                  (symbol))
2808   :version "23.1" ;; No Gnus
2809   :initialize 'custom-initialize-default
2810   :set 'gnus-summary-tool-bar-update
2811   :group 'gnus-summary)
2812
2813 (defcustom gnus-summary-tool-bar-gnome
2814   '((gnus-summary-post-news "mail/compose" nil)
2815     (gnus-summary-insert-new-articles "mail/inbox" nil
2816                                       :visible (or (not gnus-agent)
2817                                                    gnus-plugged))
2818     (gnus-summary-reply-with-original "mail/reply")
2819     (gnus-summary-reply "mail/reply" nil :visible nil)
2820     (gnus-summary-followup-with-original "mail/reply-all")
2821     (gnus-summary-followup "mail/reply-all" nil :visible nil)
2822     (gnus-summary-mail-forward "mail/forward")
2823     (gnus-summary-save-article "mail/save")
2824     (gnus-summary-search-article-forward "search" nil :visible nil)
2825     (gnus-summary-print-article "print")
2826     (gnus-summary-tick-article-forward "flag-followup" nil :visible nil)
2827     ;; Some new commands that may need more suitable icons:
2828     (gnus-summary-save-newsrc "save" nil :visible nil)
2829     ;; (gnus-summary-show-article "stock_message-display" nil :visible nil)
2830     (gnus-summary-prev-article "left-arrow")
2831     (gnus-summary-next-article "right-arrow")
2832     (gnus-summary-next-page "next-page")
2833     ;; (gnus-summary-enter-digest-group "right_arrow" nil :visible nil)
2834     ;;
2835     ;; Maybe some sort-by-... could be added:
2836     ;; (gnus-summary-sort-by-author "sort-a-z" nil :visible nil)
2837     ;; (gnus-summary-sort-by-date "sort-1-9" nil :visible nil)
2838     (gnus-summary-mark-as-expirable
2839      "delete" nil
2840      :visible (gnus-check-backend-function 'request-expire-articles
2841                                            gnus-newsgroup-name))
2842     (gnus-summary-mark-as-spam
2843      "mail/spam" t
2844      :visible (and (fboundp 'spam-group-ham-contents-p)
2845                    (spam-group-ham-contents-p gnus-newsgroup-name))
2846      :help "Mark as spam")
2847     (gnus-summary-mark-as-read-forward
2848      "mail/not-spam" nil
2849      :visible (and (fboundp 'spam-group-spam-contents-p)
2850                    (spam-group-spam-contents-p gnus-newsgroup-name)))
2851     ;;
2852     (gnus-summary-exit "exit")
2853     (gmm-customize-mode "preferences" t :help "Edit mode preferences")
2854     (gnus-info-find-node "help"))
2855   "List of functions for the summary tool bar (GNOME style).
2856
2857 See `gmm-tool-bar-from-list' for the format of the list."
2858   :type '(repeat gmm-tool-bar-item)
2859   :version "23.1" ;; No Gnus
2860   :initialize 'custom-initialize-default
2861   :set 'gnus-summary-tool-bar-update
2862   :group 'gnus-summary)
2863
2864 (defcustom gnus-summary-tool-bar-retro
2865   '((gnus-summary-prev-unread-article "gnus/prev-ur")
2866     (gnus-summary-next-unread-article "gnus/next-ur")
2867     (gnus-summary-post-news "gnus/post")
2868     (gnus-summary-followup-with-original "gnus/fuwo")
2869     (gnus-summary-followup "gnus/followup")
2870     (gnus-summary-reply-with-original "gnus/reply-wo")
2871     (gnus-summary-reply "gnus/reply")
2872     (gnus-summary-caesar-message "gnus/rot13")
2873     (gnus-uu-decode-uu "gnus/uu-decode")
2874     (gnus-summary-save-article-file "gnus/save-aif")
2875     (gnus-summary-save-article "gnus/save-art")
2876     (gnus-uu-post-news "gnus/uu-post")
2877     (gnus-summary-catchup "gnus/catchup")
2878     (gnus-summary-catchup-and-exit "gnus/cu-exit")
2879     (gnus-summary-exit "gnus/exit-summ")
2880     ;; Some new command that may need more suitable icons:
2881     (gnus-summary-print-article "gnus/print" nil :visible nil)
2882     (gnus-summary-mark-as-expirable "gnus/close" nil :visible nil)
2883     (gnus-summary-save-newsrc "gnus/save" nil :visible nil)
2884     ;; (gnus-summary-enter-digest-group "gnus/right_arrow" nil :visible nil)
2885     (gnus-summary-search-article-forward "gnus/search" nil :visible nil)
2886     ;; (gnus-summary-insert-new-articles "gnus/paste" nil :visible nil)
2887     ;; (gnus-summary-toggle-threads "gnus/open" nil :visible nil)
2888     ;;
2889     (gnus-info-find-node "gnus/help" nil :visible nil))
2890   "List of functions for the summary tool bar (retro look).
2891
2892 See `gmm-tool-bar-from-list' for the format of the list."
2893   :type '(repeat gmm-tool-bar-item)
2894   :version "23.1" ;; No Gnus
2895   :initialize 'custom-initialize-default
2896   :set 'gnus-summary-tool-bar-update
2897   :group 'gnus-summary)
2898
2899 (defcustom gnus-summary-tool-bar-zap-list t
2900   "List of icon items from the global tool bar.
2901 These items are not displayed in the Gnus summary mode tool bar.
2902
2903 See `gmm-tool-bar-from-list' for the format of the list."
2904   :type 'gmm-tool-bar-zap-list
2905   :version "23.1" ;; No Gnus
2906   :initialize 'custom-initialize-default
2907   :set 'gnus-summary-tool-bar-update
2908   :group 'gnus-summary)
2909
2910 (defvar image-load-path)
2911 (defvar tool-bar-map)
2912
2913 (defun gnus-summary-make-tool-bar (&optional force)
2914   "Make a summary mode tool bar from `gnus-summary-tool-bar'.
2915 When FORCE, rebuild the tool bar."
2916   (when (and (not (featurep 'xemacs))
2917              (boundp 'tool-bar-mode)
2918              tool-bar-mode
2919              (or (not gnus-summary-tool-bar-map) force))
2920     (let* ((load-path
2921             (gmm-image-load-path-for-library "gnus"
2922                                              "mail/save.xpm"
2923                                              nil t))
2924            (image-load-path (cons (car load-path)
2925                                   (when (boundp 'image-load-path)
2926                                     image-load-path)))
2927            (map (gmm-tool-bar-from-list gnus-summary-tool-bar
2928                                         gnus-summary-tool-bar-zap-list
2929                                         'gnus-summary-mode-map)))
2930       (when map
2931         ;; Need to set `gnus-summary-tool-bar-map' because `gnus-article-mode'
2932         ;; uses it's value.
2933         (setq gnus-summary-tool-bar-map map))))
2934   (set (make-local-variable 'tool-bar-map) gnus-summary-tool-bar-map))
2935
2936 (defun gnus-score-set-default (var value)
2937   "A version of set that updates the GNU Emacs menu-bar."
2938   (set var value)
2939   ;; It is the message that forces the active status to be updated.
2940   (message ""))
2941
2942 (defun gnus-make-score-map (type)
2943   "Make a summary score map of type TYPE."
2944   (if t
2945       nil
2946     (let ((headers '(("author" "from" string)
2947                      ("subject" "subject" string)
2948                      ("article body" "body" string)
2949                      ("article head" "head" string)
2950                      ("xref" "xref" string)
2951                      ("extra header" "extra" string)
2952                      ("lines" "lines" number)
2953                      ("followups to author" "followup" string)))
2954           (types '((number ("less than" <)
2955                            ("greater than" >)
2956                            ("equal" =))
2957                    (string ("substring" s)
2958                            ("exact string" e)
2959                            ("fuzzy string" f)
2960                            ("regexp" r))))
2961           (perms '(("temporary" (current-time-string))
2962                    ("permanent" nil)
2963                    ("immediate" now)))
2964           header)
2965       (list
2966        (apply
2967         'nconc
2968         (list
2969          (if (eq type 'lower)
2970              "Lower score"
2971            "Increase score"))
2972         (let (outh)
2973           (while headers
2974             (setq header (car headers))
2975             (setq outh
2976                   (cons
2977                    (apply
2978                     'nconc
2979                     (list (car header))
2980                     (let ((ts (cdr (assoc (nth 2 header) types)))
2981                           outt)
2982                       (while ts
2983                         (setq outt
2984                               (cons
2985                                (apply
2986                                 'nconc
2987                                 (list (caar ts))
2988                                 (let ((ps perms)
2989                                       outp)
2990                                   (while ps
2991                                     (setq outp
2992                                           (cons
2993                                            (vector
2994                                             (caar ps)
2995                                             (list
2996                                              'gnus-summary-score-entry
2997                                              (nth 1 header)
2998                                              (if (or (string= (nth 1 header)
2999                                                               "head")
3000                                                      (string= (nth 1 header)
3001                                                               "body"))
3002                                                  ""
3003                                                (list 'gnus-summary-header
3004                                                      (nth 1 header)))
3005                                              (list 'quote (nth 1 (car ts)))
3006                                              (list 'gnus-score-delta-default
3007                                                    nil)
3008                                              (nth 1 (car ps))
3009                                              t)
3010                                             t)
3011                                            outp))
3012                                     (setq ps (cdr ps)))
3013                                   (list (nreverse outp))))
3014                                outt))
3015                         (setq ts (cdr ts)))
3016                       (list (nreverse outt))))
3017                    outh))
3018             (setq headers (cdr headers)))
3019           (list (nreverse outh))))))))
3020
3021
3022 (declare-function turn-on-gnus-mailing-list-mode "gnus-ml" ())
3023 (defvar bookmark-make-record-function)
3024 \f
3025
3026 (defun gnus-summary-mode (&optional group)
3027   "Major mode for reading articles.
3028
3029 All normal editing commands are switched off.
3030 \\<gnus-summary-mode-map>
3031 Each line in this buffer represents one article.  To read an
3032 article, you can, for instance, type `\\[gnus-summary-next-page]'.  To move forwards
3033 and backwards while displaying articles, type `\\[gnus-summary-next-unread-article]' and `\\[gnus-summary-prev-unread-article]',
3034 respectively.
3035
3036 You can also post articles and send mail from this buffer.  To
3037 follow up an article, type `\\[gnus-summary-followup]'.  To mail a reply to the author
3038 of an article, type `\\[gnus-summary-reply]'.
3039
3040 There are approx. one gazillion commands you can execute in this
3041 buffer; read the info pages for more information (`\\[gnus-info-find-node]').
3042
3043 The following commands are available:
3044
3045 \\{gnus-summary-mode-map}"
3046   (interactive)
3047   (kill-all-local-variables)
3048   (let ((gnus-summary-local-variables gnus-newsgroup-variables))
3049     (gnus-summary-make-local-variables))
3050   (gnus-summary-make-local-variables)
3051   (setq gnus-newsgroup-name group)
3052   (when (gnus-visual-p 'summary-menu 'menu)
3053     (gnus-summary-make-menu-bar)
3054     (gnus-summary-make-tool-bar))
3055   (gnus-make-thread-indent-array)
3056   (gnus-simplify-mode-line)
3057   (setq major-mode 'gnus-summary-mode)
3058   (setq mode-name "Summary")
3059   (use-local-map gnus-summary-mode-map)
3060   (buffer-disable-undo)
3061   (setq buffer-read-only t              ;Disable modification
3062         show-trailing-whitespace nil)
3063   (setq truncate-lines t)
3064   (add-to-invisibility-spec '(gnus-sum . t))
3065   (gnus-summary-set-display-table)
3066   (gnus-set-default-directory)
3067   (make-local-variable 'gnus-summary-line-format)
3068   (make-local-variable 'gnus-summary-line-format-spec)
3069   (make-local-variable 'gnus-summary-dummy-line-format)
3070   (make-local-variable 'gnus-summary-dummy-line-format-spec)
3071   (make-local-variable 'gnus-summary-mark-positions)
3072   (gnus-make-local-hook 'pre-command-hook)
3073   (add-hook 'pre-command-hook 'gnus-set-global-variables nil t)
3074   (gnus-run-mode-hooks 'gnus-summary-mode-hook)
3075   (turn-on-gnus-mailing-list-mode)
3076   (mm-enable-multibyte)
3077   (set (make-local-variable 'bookmark-make-record-function)
3078        'gnus-summary-bookmark-make-record)
3079   (gnus-update-format-specifications nil 'summary 'summary-mode 'summary-dummy)
3080   (gnus-update-summary-mark-positions))
3081
3082 (defun gnus-summary-make-local-variables ()
3083   "Make all the local summary buffer variables."
3084   (let (global)
3085     (dolist (local gnus-summary-local-variables)
3086       (if (consp local)
3087           (progn
3088             (if (eq (cdr local) 'global)
3089                 ;; Copy the global value of the variable.
3090                 (setq global (symbol-value (car local)))
3091               ;; Use the value from the list.
3092               (setq global (eval (cdr local))))
3093             (set (make-local-variable (car local)) global))
3094         ;; Simple nil-valued local variable.
3095         (set (make-local-variable local) nil)))))
3096
3097 (defun gnus-summary-clear-local-variables ()
3098   (let ((locals gnus-summary-local-variables))
3099     (while locals
3100       (if (consp (car locals))
3101           (and (symbolp (caar locals))
3102                (set (caar locals) nil))
3103         (and (symbolp (car locals))
3104              (set (car locals) nil)))
3105       (setq locals (cdr locals)))))
3106
3107 ;; Summary data functions.
3108
3109 (defmacro gnus-data-number (data)
3110   `(car ,data))
3111
3112 (defmacro gnus-data-set-number (data number)
3113   `(setcar ,data ,number))
3114
3115 (defmacro gnus-data-mark (data)
3116   `(nth 1 ,data))
3117
3118 (defmacro gnus-data-set-mark (data mark)
3119   `(setcar (nthcdr 1 ,data) ,mark))
3120
3121 (defmacro gnus-data-pos (data)
3122   `(nth 2 ,data))
3123
3124 (defmacro gnus-data-set-pos (data pos)
3125   `(setcar (nthcdr 2 ,data) ,pos))
3126
3127 (defmacro gnus-data-header (data)
3128   `(nth 3 ,data))
3129
3130 (defmacro gnus-data-set-header (data header)
3131   `(setf (nth 3 ,data) ,header))
3132
3133 (defmacro gnus-data-level (data)
3134   `(nth 4 ,data))
3135
3136 (defmacro gnus-data-unread-p (data)
3137   `(= (nth 1 ,data) gnus-unread-mark))
3138
3139 (defmacro gnus-data-read-p (data)
3140   `(/= (nth 1 ,data) gnus-unread-mark))
3141
3142 (defmacro gnus-data-pseudo-p (data)
3143   `(consp (nth 3 ,data)))
3144
3145 (defmacro gnus-data-find (number)
3146   `(assq ,number gnus-newsgroup-data))
3147
3148 (defmacro gnus-data-find-list (number &optional data)
3149   `(let ((bdata ,(or data 'gnus-newsgroup-data)))
3150      (memq (assq ,number bdata)
3151            bdata)))
3152
3153 (defmacro gnus-data-make (number mark pos header level)
3154   `(list ,number ,mark ,pos ,header ,level))
3155
3156 (defun gnus-data-enter (after-article number mark pos header level offset)
3157   (let ((data (gnus-data-find-list after-article)))
3158     (unless data
3159       (error "No such article: %d" after-article))
3160     (setcdr data (cons (gnus-data-make number mark pos header level)
3161                        (cdr data)))
3162     (setq gnus-newsgroup-data-reverse nil)
3163     (gnus-data-update-list (cddr data) offset)))
3164
3165 (defun gnus-data-enter-list (after-article list &optional offset)
3166   (when list
3167     (let ((data (and after-article (gnus-data-find-list after-article)))
3168           (ilist list))
3169       (if (not (or data
3170                    after-article))
3171           (let ((odata gnus-newsgroup-data))
3172             (setq gnus-newsgroup-data (nconc list gnus-newsgroup-data))
3173             (when offset
3174               (gnus-data-update-list odata offset)))
3175         ;; Find the last element in the list to be spliced into the main
3176         ;; list.
3177         (setq list (last list))
3178         (if (not data)
3179             (progn
3180               (setcdr list gnus-newsgroup-data)
3181               (setq gnus-newsgroup-data ilist)
3182               (when offset
3183                 (gnus-data-update-list (cdr list) offset)))
3184           (setcdr list (cdr data))
3185           (setcdr data ilist)
3186           (when offset
3187             (gnus-data-update-list (cdr list) offset))))
3188       (setq gnus-newsgroup-data-reverse nil))))
3189
3190 (defun gnus-data-remove (article &optional offset)
3191   (let ((data gnus-newsgroup-data))
3192     (if (= (gnus-data-number (car data)) article)
3193         (progn
3194           (setq gnus-newsgroup-data (cdr gnus-newsgroup-data)
3195                 gnus-newsgroup-data-reverse nil)
3196           (when offset
3197             (gnus-data-update-list gnus-newsgroup-data offset)))
3198       (while (cdr data)
3199         (when (= (gnus-data-number (cadr data)) article)
3200           (setcdr data (cddr data))
3201           (when offset
3202             (gnus-data-update-list (cdr data) offset))
3203           (setq data nil
3204                 gnus-newsgroup-data-reverse nil))
3205         (setq data (cdr data))))))
3206
3207 (defmacro gnus-data-list (backward)
3208   `(if ,backward
3209        (or gnus-newsgroup-data-reverse
3210            (setq gnus-newsgroup-data-reverse
3211                  (reverse gnus-newsgroup-data)))
3212      gnus-newsgroup-data))
3213
3214 (defun gnus-data-update-list (data offset)
3215   "Add OFFSET to the POS of all data entries in DATA."
3216   (setq gnus-newsgroup-data-reverse nil)
3217   (while data
3218     (setcar (nthcdr 2 (car data)) (+ offset (nth 2 (car data))))
3219     (setq data (cdr data))))
3220
3221 (defun gnus-summary-article-pseudo-p (article)
3222   "Say whether this article is a pseudo article or not."
3223   (not (vectorp (gnus-data-header (gnus-data-find article)))))
3224
3225 (defmacro gnus-summary-article-sparse-p (article)
3226   "Say whether this article is a sparse article or not."
3227   `(memq ,article gnus-newsgroup-sparse))
3228
3229 (defmacro gnus-summary-article-ancient-p (article)
3230   "Say whether this article is a sparse article or not."
3231   `(memq ,article gnus-newsgroup-ancient))
3232
3233 (defun gnus-article-parent-p (number)
3234   "Say whether this article is a parent or not."
3235   (let ((data (gnus-data-find-list number)))
3236     (and (cdr data)              ; There has to be an article after...
3237          (< (gnus-data-level (car data)) ; And it has to have a higher level.
3238             (gnus-data-level (nth 1 data))))))
3239
3240 (defun gnus-article-children (number)
3241   "Return a list of all children to NUMBER."
3242   (let* ((data (gnus-data-find-list number))
3243          (level (gnus-data-level (car data)))
3244          children)
3245     (setq data (cdr data))
3246     (while (and data
3247                 (= (gnus-data-level (car data)) (1+ level)))
3248       (push (gnus-data-number (car data)) children)
3249       (setq data (cdr data)))
3250     children))
3251
3252 (defmacro gnus-summary-skip-intangible ()
3253   "If the current article is intangible, then jump to a different article."
3254   '(let ((to (get-text-property (point) 'gnus-intangible)))
3255      (and to (gnus-summary-goto-subject to))))
3256
3257 (defmacro gnus-summary-article-intangible-p ()
3258   "Say whether this article is intangible or not."
3259   '(get-text-property (point) 'gnus-intangible))
3260
3261 (defun gnus-article-read-p (article)
3262   "Say whether ARTICLE is read or not."
3263   (not (or (memq article gnus-newsgroup-marked)
3264            (memq article gnus-newsgroup-spam-marked)
3265            (memq article gnus-newsgroup-unreads)
3266            (memq article gnus-newsgroup-unselected)
3267            (memq article gnus-newsgroup-dormant))))
3268
3269 ;; Some summary mode macros.
3270
3271 (defmacro gnus-summary-article-number ()
3272   "The article number of the article on the current line.
3273 If there isn't an article number here, then we return the current
3274 article number."
3275   '(progn
3276      (gnus-summary-skip-intangible)
3277      (or (get-text-property (point) 'gnus-number)
3278          (gnus-summary-last-subject))))
3279
3280 (defmacro gnus-summary-article-header (&optional number)
3281   "Return the header of article NUMBER."
3282   `(gnus-data-header (gnus-data-find
3283                       ,(or number '(gnus-summary-article-number)))))
3284
3285 (defmacro gnus-summary-thread-level (&optional number)
3286   "Return the level of thread that starts with article NUMBER."
3287   `(if (and (eq gnus-summary-make-false-root 'dummy)
3288             (get-text-property (point) 'gnus-intangible))
3289        0
3290      (gnus-data-level (gnus-data-find
3291                        ,(or number '(gnus-summary-article-number))))))
3292
3293 (defmacro gnus-summary-article-mark (&optional number)
3294   "Return the mark of article NUMBER."
3295   `(gnus-data-mark (gnus-data-find
3296                     ,(or number '(gnus-summary-article-number)))))
3297
3298 (defmacro gnus-summary-article-pos (&optional number)
3299   "Return the position of the line of article NUMBER."
3300   `(gnus-data-pos (gnus-data-find
3301                    ,(or number '(gnus-summary-article-number)))))
3302
3303 (defalias 'gnus-summary-subject-string 'gnus-summary-article-subject)
3304 (defmacro gnus-summary-article-subject (&optional number)
3305   "Return current subject string or nil if nothing."
3306   `(let ((headers
3307           ,(if number
3308                `(gnus-data-header (assq ,number gnus-newsgroup-data))
3309              '(gnus-data-header (assq (gnus-summary-article-number)
3310                                       gnus-newsgroup-data)))))
3311      (and headers
3312           (vectorp headers)
3313           (mail-header-subject headers))))
3314
3315 (defmacro gnus-summary-article-score (&optional number)
3316   "Return current article score."
3317   `(or (cdr (assq ,(or number '(gnus-summary-article-number))
3318                   gnus-newsgroup-scored))
3319        gnus-summary-default-score 0))
3320
3321 (defun gnus-summary-article-children (&optional number)
3322   "Return a list of article numbers that are children of article NUMBER."
3323   (let* ((data (gnus-data-find-list (or number (gnus-summary-article-number))))
3324          (level (gnus-data-level (car data)))
3325          l children)
3326     (while (and (setq data (cdr data))
3327                 (> (setq l (gnus-data-level (car data))) level))
3328       (and (= (1+ level) l)
3329            (push (gnus-data-number (car data))
3330                  children)))
3331     (nreverse children)))
3332
3333 (defun gnus-summary-article-parent (&optional number)
3334   "Return the article number of the parent of article NUMBER."
3335   (let* ((data (gnus-data-find-list (or number (gnus-summary-article-number))
3336                                     (gnus-data-list t)))
3337          (level (gnus-data-level (car data))))
3338     (if (zerop level)
3339         ()                              ; This is a root.
3340       ;; We search until we find an article with a level less than
3341       ;; this one.  That function has to be the parent.
3342       (while (and (setq data (cdr data))
3343                   (not (< (gnus-data-level (car data)) level))))
3344       (and data (gnus-data-number (car data))))))
3345
3346 (defun gnus-unread-mark-p (mark)
3347   "Say whether MARK is the unread mark."
3348   (= mark gnus-unread-mark))
3349
3350 (defun gnus-read-mark-p (mark)
3351   "Say whether MARK is one of the marks that mark as read.
3352 This is all marks except unread, ticked, dormant, and expirable."
3353   (not (or (= mark gnus-unread-mark)
3354            (= mark gnus-ticked-mark)
3355            (= mark gnus-spam-mark)
3356            (= mark gnus-dormant-mark)
3357            (= mark gnus-expirable-mark))))
3358
3359 (defmacro gnus-article-mark (number)
3360   "Return the MARK of article NUMBER.
3361 This macro should only be used when computing the mark the \"first\"
3362 time; i.e., when generating the summary lines.  After that,
3363 `gnus-summary-article-mark' should be used to examine the
3364 marks of articles."
3365   `(cond
3366     ((memq ,number gnus-newsgroup-unsendable) gnus-unsendable-mark)
3367     ((memq ,number gnus-newsgroup-downloadable) gnus-downloadable-mark)
3368     ((memq ,number gnus-newsgroup-unreads) gnus-unread-mark)
3369     ((memq ,number gnus-newsgroup-marked) gnus-ticked-mark)
3370     ((memq ,number gnus-newsgroup-spam-marked) gnus-spam-mark)
3371     ((memq ,number gnus-newsgroup-dormant) gnus-dormant-mark)
3372     ((memq ,number gnus-newsgroup-expirable) gnus-expirable-mark)
3373     (t (or (cdr (assq ,number gnus-newsgroup-reads))
3374            gnus-ancient-mark))))
3375
3376 ;; Saving hidden threads.
3377
3378 (defmacro gnus-save-hidden-threads (&rest forms)
3379   "Save hidden threads, eval FORMS, and restore the hidden threads."
3380   (let ((config (make-symbol "config")))
3381     `(let ((,config (gnus-hidden-threads-configuration)))
3382        (unwind-protect
3383            (save-excursion
3384              ,@forms)
3385          (gnus-restore-hidden-threads-configuration ,config)))))
3386 (put 'gnus-save-hidden-threads 'lisp-indent-function 0)
3387 (put 'gnus-save-hidden-threads 'edebug-form-spec '(body))
3388
3389 (defun gnus-data-compute-positions ()
3390   "Compute the positions of all articles."
3391   (setq gnus-newsgroup-data-reverse nil)
3392   (let ((data gnus-newsgroup-data))
3393     (save-excursion
3394       (gnus-save-hidden-threads
3395         (gnus-summary-show-all-threads)
3396         (goto-char (point-min))
3397         (while data
3398           (while (get-text-property (point) 'gnus-intangible)
3399             (forward-line 1))
3400           (gnus-data-set-pos (car data) (+ (point) 3))
3401           (setq data (cdr data))
3402           (forward-line 1))))))
3403
3404 (defun gnus-hidden-threads-configuration ()
3405   "Return the current hidden threads configuration."
3406   (save-excursion
3407     (let (config)
3408       (goto-char (point-min))
3409       (while (not (eobp))
3410         (when (eq (get-char-property (point-at-eol) 'invisible) 'gnus-sum)
3411           (push (save-excursion (forward-line 0) (point)) config))
3412         (forward-line 1))
3413       config)))
3414
3415 (defun gnus-restore-hidden-threads-configuration (config)
3416   "Restore hidden threads configuration from CONFIG."
3417   (save-excursion
3418     (let (point (inhibit-read-only t))
3419       (while (setq point (pop config))
3420         (goto-char point)
3421         (gnus-summary-hide-thread)))))
3422
3423 ;; Various summary mode internalish functions.
3424
3425 (defun gnus-mouse-pick-article (e)
3426   (interactive "e")
3427   (mouse-set-point e)
3428   (gnus-summary-next-page nil t))
3429
3430 (defun gnus-summary-set-display-table ()
3431   "Change the display table.
3432 Odd characters have a tendency to mess
3433 up nicely formatted displays - we make all possible glyphs
3434 display only a single character."
3435
3436   ;; We start from the standard display table, if any.
3437   (let ((table (or (copy-sequence standard-display-table)
3438                    (make-display-table)))
3439         (i 32))
3440     ;; Nix out all the control chars...
3441     (while (>= (setq i (1- i)) 0)
3442       (gnus-put-display-table i [??] table))
3443    ;; ... but not newline and cr, of course.  (cr is necessary for the
3444     ;; selective display).
3445     (gnus-put-display-table ?\n nil table)
3446     (gnus-put-display-table ?\r nil table)
3447     ;; We keep TAB as well.
3448     (gnus-put-display-table ?\t nil table)
3449     ;; We nix out any glyphs 127 through 255, or 127 through 159 in
3450     ;; Emacs 23 (unicode), that are not set already.
3451     (let ((i (if (ignore-errors (= (make-char 'latin-iso8859-1 160) 160))
3452                  160
3453                256)))
3454       (while (>= (setq i (1- i)) 127)
3455         ;; Only modify if the entry is nil.
3456         (unless (gnus-get-display-table i table)
3457           (gnus-put-display-table i [??] table))))
3458     (setq buffer-display-table table)))
3459
3460 (defun gnus-summary-set-article-display-arrow (pos)
3461   "Update the overlay arrow to point to line at position POS."
3462   (when gnus-summary-display-arrow
3463     (make-local-variable 'overlay-arrow-position)
3464     (make-local-variable 'overlay-arrow-string)
3465     (save-excursion
3466       (goto-char pos)
3467       (beginning-of-line)
3468       (unless overlay-arrow-position
3469         (setq overlay-arrow-position (make-marker)))
3470       (setq overlay-arrow-string "=>"
3471             overlay-arrow-position (set-marker overlay-arrow-position
3472                                                (point)
3473                                                (current-buffer))))))
3474
3475 (defun gnus-summary-setup-buffer (group)
3476   "Initialize summary buffer."
3477   (let ((buffer (gnus-summary-buffer-name group))
3478         (dead-name (concat "*Dead Summary "
3479                            (gnus-group-decoded-name group) "*")))
3480     ;; If a dead summary buffer exists, we kill it.
3481     (when (gnus-buffer-live-p dead-name)
3482       (gnus-kill-buffer dead-name))
3483     (if (get-buffer buffer)
3484         (progn
3485           (set-buffer buffer)
3486           (setq gnus-summary-buffer (current-buffer))
3487           (not gnus-newsgroup-prepared))
3488       ;; Fix by Sudish Joseph <joseph@cis.ohio-state.edu>
3489       (setq gnus-summary-buffer (set-buffer (gnus-get-buffer-create buffer)))
3490       (gnus-summary-mode group)
3491       (when gnus-carpal
3492         (gnus-carpal-setup-buffer 'summary))
3493       (when (gnus-group-quit-config group)
3494         (set (make-local-variable 'gnus-single-article-buffer) nil))
3495       (make-local-variable 'gnus-article-buffer)
3496       (make-local-variable 'gnus-article-current)
3497       (make-local-variable 'gnus-original-article-buffer)
3498       (setq gnus-newsgroup-name group)
3499       ;; Set any local variables in the group parameters.
3500       (gnus-summary-set-local-parameters gnus-newsgroup-name)
3501       t)))
3502
3503 (defun gnus-set-global-variables ()
3504   "Set the global equivalents of the buffer-local variables.
3505 They are set to the latest values they had.  These reflect the summary
3506 buffer that was in action when the last article was fetched."
3507   (when (eq major-mode 'gnus-summary-mode)
3508     (setq gnus-summary-buffer (current-buffer))
3509     (let ((name gnus-newsgroup-name)
3510           (marked gnus-newsgroup-marked)
3511           (spam gnus-newsgroup-spam-marked)
3512           (unread gnus-newsgroup-unreads)
3513           (headers gnus-current-headers)
3514           (data gnus-newsgroup-data)
3515           (summary gnus-summary-buffer)
3516           (article-buffer gnus-article-buffer)
3517           (original gnus-original-article-buffer)
3518           (gac gnus-article-current)
3519           (reffed gnus-reffed-article-number)
3520           (score-file gnus-current-score-file)
3521           (default-charset gnus-newsgroup-charset)
3522           vlist)
3523       (let ((locals gnus-newsgroup-variables))
3524         (while locals
3525           (if (consp (car locals))
3526               (push (eval (caar locals)) vlist)
3527             (push (eval (car locals)) vlist))
3528           (setq locals (cdr locals)))
3529         (setq vlist (nreverse vlist)))
3530       (with-current-buffer gnus-group-buffer
3531         (setq gnus-newsgroup-name name
3532               gnus-newsgroup-marked marked
3533               gnus-newsgroup-spam-marked spam
3534               gnus-newsgroup-unreads unread
3535               gnus-current-headers headers
3536               gnus-newsgroup-data data
3537               gnus-article-current gac
3538               gnus-summary-buffer summary
3539               gnus-article-buffer article-buffer
3540               gnus-original-article-buffer original
3541               gnus-reffed-article-number reffed
3542               gnus-current-score-file score-file
3543               gnus-newsgroup-charset default-charset)
3544         (let ((locals gnus-newsgroup-variables))
3545           (while locals
3546             (if (consp (car locals))
3547                 (set (caar locals) (pop vlist))
3548               (set (car locals) (pop vlist)))
3549             (setq locals (cdr locals))))
3550         ;; The article buffer also has local variables.
3551         (when (gnus-buffer-live-p gnus-article-buffer)
3552           (set-buffer gnus-article-buffer)
3553           (setq gnus-summary-buffer summary))))))
3554
3555 (defun gnus-summary-article-unread-p (article)
3556   "Say whether ARTICLE is unread or not."
3557   (memq article gnus-newsgroup-unreads))
3558
3559 (defun gnus-summary-first-article-p (&optional article)
3560   "Return whether ARTICLE is the first article in the buffer."
3561   (if (not (setq article (or article (gnus-summary-article-number))))
3562       nil
3563     (eq article (caar gnus-newsgroup-data))))
3564
3565 (defun gnus-summary-last-article-p (&optional article)
3566   "Return whether ARTICLE is the last article in the buffer."
3567   (if (not (setq article (or article (gnus-summary-article-number))))
3568       ;; All non-existent numbers are the last article.  :-)
3569       t
3570     (not (cdr (gnus-data-find-list article)))))
3571
3572 (defun gnus-make-thread-indent-array (&optional n)
3573   (when (or n
3574             (progn (setq n 200) nil)
3575             (null gnus-thread-indent-array)
3576             (/= gnus-thread-indent-level gnus-thread-indent-array-level))
3577     (setq gnus-thread-indent-array (make-vector (1+ n) "")
3578           gnus-thread-indent-array-level gnus-thread-indent-level)
3579     (while (>= n 0)
3580       (aset gnus-thread-indent-array n
3581             (make-string (* n gnus-thread-indent-level) ? ))
3582       (setq n (1- n)))))
3583
3584 (defun gnus-update-summary-mark-positions ()
3585   "Compute where the summary marks are to go."
3586   (save-excursion
3587     (when (gnus-buffer-exists-p gnus-summary-buffer)
3588       (set-buffer gnus-summary-buffer))
3589     (let ((spec gnus-summary-line-format-spec)
3590           pos)
3591       (save-excursion
3592         (gnus-set-work-buffer)
3593         (let ((gnus-tmp-unread ?Z)
3594               (gnus-replied-mark ?Z)
3595               (gnus-score-below-mark ?Z)
3596               (gnus-score-over-mark ?Z)
3597               (gnus-undownloaded-mark ?Z)
3598               (gnus-summary-line-format-spec spec)
3599               (gnus-newsgroup-downloadable '(0))
3600               (header [0 "" "" "05 Apr 2001 23:33:09 +0400" "" "" 0 0 "" nil])
3601               case-fold-search ignores)
3602           ;; Here, all marks are bound to Z.
3603           (gnus-summary-insert-line header
3604                                     0 nil t gnus-tmp-unread t nil "" nil 1)
3605           (goto-char (point-min))
3606           ;; Memorize the positions of the same characters as dummy marks.
3607           (while (re-search-forward "[A-D]" nil t)
3608             (push (point) ignores))
3609           (erase-buffer)
3610           ;; We use A-D as dummy marks in order to know column positions
3611           ;; where marks should be inserted.
3612           (setq gnus-tmp-unread ?A
3613                 gnus-replied-mark ?B
3614                 gnus-score-below-mark ?C
3615                 gnus-score-over-mark ?C
3616                 gnus-undownloaded-mark ?D)
3617           (gnus-summary-insert-line header
3618                                     0 nil t gnus-tmp-unread t nil "" nil 1)
3619           ;; Ignore characters which aren't dummy marks.
3620           (dolist (p ignores)
3621             (delete-region (goto-char (1- p)) p)
3622             (insert ?Z))
3623           (goto-char (point-min))
3624           (setq pos (list (cons 'unread
3625                                 (and (search-forward "A" nil t)
3626                                      (- (point) (point-min) 1)))))
3627           (goto-char (point-min))
3628           (push (cons 'replied (and (search-forward "B" nil t)
3629                                     (- (point) (point-min) 1)))
3630                 pos)
3631           (goto-char (point-min))
3632           (push (cons 'score (and (search-forward "C" nil t)
3633                                   (- (point) (point-min) 1)))
3634                 pos)
3635           (goto-char (point-min))
3636           (push (cons 'download (and (search-forward "D" nil t)
3637                                      (- (point) (point-min) 1)))
3638                 pos)))
3639       (setq gnus-summary-mark-positions pos))))
3640
3641 (defun gnus-summary-insert-dummy-line (gnus-tmp-subject gnus-tmp-number)
3642   "Insert a dummy root in the summary buffer."
3643   (beginning-of-line)
3644   (gnus-add-text-properties
3645    (point) (progn (eval gnus-summary-dummy-line-format-spec) (point))
3646    (list 'gnus-number gnus-tmp-number 'gnus-intangible gnus-tmp-number)))
3647
3648 (defun gnus-summary-extract-address-component (from)
3649   (or (car (funcall gnus-extract-address-components from))
3650       from))
3651
3652 (defun gnus-summary-from-or-to-or-newsgroups (header gnus-tmp-from)
3653   (let ((mail-parse-charset gnus-newsgroup-charset)
3654         (ignored-from-addresses (gnus-ignored-from-addresses))
3655         ; Is it really necessary to do this next part for each summary line?
3656         ; Luckily, doesn't seem to slow things down much.
3657         (mail-parse-ignored-charsets
3658          (with-current-buffer gnus-summary-buffer
3659            gnus-newsgroup-ignored-charsets)))
3660     (or
3661      (and ignored-from-addresses
3662           (string-match ignored-from-addresses gnus-tmp-from)
3663           (let ((extra-headers (mail-header-extra header))
3664                 to
3665                 newsgroups)
3666             (cond
3667              ((setq to (cdr (assq 'To extra-headers)))
3668               (concat gnus-summary-to-prefix
3669                       (inline
3670                         (gnus-summary-extract-address-component
3671                          (funcall gnus-decode-encoded-address-function to)))))
3672              ((setq newsgroups
3673                     (or
3674                      (cdr (assq 'Newsgroups extra-headers))
3675                      (and
3676                       (memq 'Newsgroups gnus-extra-headers)
3677                       (eq (car (gnus-find-method-for-group
3678                                 gnus-newsgroup-name)) 'nntp)
3679                       (gnus-group-real-name gnus-newsgroup-name))))
3680               (concat gnus-summary-newsgroup-prefix newsgroups)))))
3681      (inline (gnus-summary-extract-address-component gnus-tmp-from)))))
3682
3683 (defun gnus-summary-insert-line (gnus-tmp-header
3684                                  gnus-tmp-level gnus-tmp-current
3685                                  undownloaded gnus-tmp-unread gnus-tmp-replied
3686                                  gnus-tmp-expirable gnus-tmp-subject-or-nil
3687                                  &optional gnus-tmp-dummy gnus-tmp-score
3688                                  gnus-tmp-process)
3689   (if (>= gnus-tmp-level (length gnus-thread-indent-array))
3690       (gnus-make-thread-indent-array (max (* 2 (length gnus-thread-indent-array))
3691                                           gnus-tmp-level)))
3692   (let* ((gnus-tmp-indentation (aref gnus-thread-indent-array gnus-tmp-level))
3693          (gnus-tmp-lines (mail-header-lines gnus-tmp-header))
3694          (gnus-tmp-score (or gnus-tmp-score gnus-summary-default-score 0))
3695          (gnus-tmp-score-char
3696           (if (or (null gnus-summary-default-score)
3697                   (<= (abs (- gnus-tmp-score gnus-summary-default-score))
3698                       gnus-summary-zcore-fuzz))
3699               ?                         ;Whitespace
3700             (if (< gnus-tmp-score gnus-summary-default-score)
3701                 gnus-score-below-mark gnus-score-over-mark)))
3702          (gnus-tmp-number (mail-header-number gnus-tmp-header))
3703          (gnus-tmp-replied
3704           (cond (gnus-tmp-process gnus-process-mark)
3705                 ((memq gnus-tmp-current gnus-newsgroup-cached)
3706                  gnus-cached-mark)
3707                 (gnus-tmp-replied gnus-replied-mark)
3708                 ((memq gnus-tmp-current gnus-newsgroup-forwarded)
3709                  gnus-forwarded-mark)
3710                 ((memq gnus-tmp-current gnus-newsgroup-saved)
3711                  gnus-saved-mark)
3712                 ((memq gnus-tmp-number gnus-newsgroup-recent)
3713                  gnus-recent-mark)
3714                 ((memq gnus-tmp-number gnus-newsgroup-unseen)
3715                  gnus-unseen-mark)
3716                 (t gnus-no-mark)))
3717          (gnus-tmp-downloaded
3718           (cond (undownloaded
3719                  gnus-undownloaded-mark)
3720                 (gnus-newsgroup-agentized
3721                  gnus-downloaded-mark)
3722                 (t
3723                  gnus-no-mark)))
3724          (gnus-tmp-from (mail-header-from gnus-tmp-header))
3725          (gnus-tmp-name
3726           (cond
3727            ((string-match "<[^>]+> *$" gnus-tmp-from)
3728             (let ((beg (match-beginning 0)))
3729               (or (and (string-match "^\".+\"" gnus-tmp-from)
3730                        (substring gnus-tmp-from 1 (1- (match-end 0))))
3731                   (substring gnus-tmp-from 0 beg))))
3732            ((string-match "(.+)" gnus-tmp-from)
3733             (substring gnus-tmp-from
3734                        (1+ (match-beginning 0)) (1- (match-end 0))))
3735            (t gnus-tmp-from)))
3736          (gnus-tmp-subject (mail-header-subject gnus-tmp-header))
3737          (gnus-tmp-opening-bracket (if gnus-tmp-dummy ?\< ?\[))
3738          (gnus-tmp-closing-bracket (if gnus-tmp-dummy ?\> ?\]))