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