* binhex.el (binhex-decode-region-internal)
[gnus] / lisp / gnus-salt.el
1 ;;; gnus-salt.el --- alternate summary mode interfaces for Gnus
2
3 ;; Copyright (C) 1996, 1997, 1998, 1999, 2001, 2002, 2003, 2004, 2005,
4 ;;   2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
5
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7 ;; Keywords: news
8
9 ;; This file is part of GNU Emacs.
10
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
15
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19 ;; GNU General Public License for more details.
20
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
23
24 ;;; Commentary:
25
26 ;;; Code:
27
28 (eval-when-compile (require 'cl))
29 (eval-when-compile
30   (when (featurep 'xemacs)
31     (require 'easy-mmode))) ; for `define-minor-mode'
32
33 (require 'gnus)
34 (require 'gnus-sum)
35 (require 'gnus-win)
36
37 ;;;
38 ;;; gnus-pick-mode
39 ;;;
40
41 (defcustom gnus-pick-display-summary nil
42   "*Display summary while reading."
43   :type 'boolean
44   :group 'gnus-summary-pick)
45
46 (defcustom gnus-pick-mode-hook nil
47   "Hook run in summary pick mode buffers."
48   :type 'hook
49   :group 'gnus-summary-pick)
50
51 (when (featurep 'xemacs)
52   (add-hook 'gnus-pick-mode-hook 'gnus-xmas-pick-menu-add))
53
54 (defcustom gnus-mark-unpicked-articles-as-read nil
55   "*If non-nil, mark all unpicked articles as read."
56   :type 'boolean
57   :group 'gnus-summary-pick)
58
59 (defcustom gnus-pick-elegant-flow t
60   "If non-nil, `gnus-pick-start-reading' runs
61  `gnus-summary-next-group' when no articles have been picked."
62   :type 'boolean
63   :group 'gnus-summary-pick)
64
65 (defcustom gnus-summary-pick-line-format
66   "%-5P %U\%R\%z\%I\%(%[%4L: %-23,23n%]%) %s\n"
67   "*The format specification of the lines in pick buffers.
68 It accepts the same format specs that `gnus-summary-line-format' does."
69   :type 'string
70   :group 'gnus-summary-pick)
71
72 ;;; Internal variables.
73
74 (defvar gnus-pick-mode-map
75   (let ((map (make-sparse-keymap)))
76     (gnus-define-keys map
77       " " gnus-pick-next-page
78       "u" gnus-pick-unmark-article-or-thread
79       "." gnus-pick-article-or-thread
80       gnus-down-mouse-2 gnus-pick-mouse-pick-region
81       "\r" gnus-pick-start-reading)
82     map))
83
84 (defun gnus-pick-make-menu-bar ()
85   (unless (boundp 'gnus-pick-menu)
86     (easy-menu-define
87       gnus-pick-menu gnus-pick-mode-map ""
88       '("Pick"
89         ("Pick"
90          ["Article" gnus-summary-mark-as-processable t]
91          ["Thread" gnus-uu-mark-thread t]
92          ["Region" gnus-uu-mark-region t]
93          ["Regexp" gnus-uu-mark-by-regexp t]
94          ["Buffer" gnus-uu-mark-buffer t])
95         ("Unpick"
96          ["Article" gnus-summary-unmark-as-processable t]
97          ["Thread" gnus-uu-unmark-thread t]
98          ["Region" gnus-uu-unmark-region t]
99          ["Regexp" gnus-uu-unmark-by-regexp t]
100          ["Buffer" gnus-summary-unmark-all-processable t])
101         ["Start reading" gnus-pick-start-reading t]
102         ["Switch pick mode off" gnus-pick-mode gnus-pick-mode]))))
103
104 (eval-when-compile
105   (when (featurep 'xemacs)
106     (defvar gnus-pick-mode-on-hook)
107     (defvar gnus-pick-mode-off-hook)))
108
109 (define-minor-mode gnus-pick-mode
110   "Minor mode for providing a pick-and-read interface in Gnus summary buffers.
111
112 \\{gnus-pick-mode-map}"
113   :lighter " Pick" :keymap gnus-pick-mode-map
114   (cond
115    ((not (derived-mode-p 'gnus-summary-mode)) (setq gnus-pick-mode nil))
116    ((not gnus-pick-mode)
117     ;; FIXME: a buffer-local minor mode removing globally from a hook??
118     (remove-hook 'gnus-message-setup-hook 'gnus-pick-setup-message))
119    (t
120     ;; Make sure that we don't select any articles upon group entry.
121     (set (make-local-variable 'gnus-auto-select-first) nil)
122     ;; Change line format.
123     (setq gnus-summary-line-format gnus-summary-pick-line-format)
124     (setq gnus-summary-line-format-spec nil)
125     (gnus-update-format-specifications nil 'summary)
126     (gnus-update-summary-mark-positions)
127     ;; FIXME: a buffer-local minor mode adding globally to a hook??
128     (add-hook 'gnus-message-setup-hook 'gnus-pick-setup-message)
129     (set (make-local-variable 'gnus-summary-goto-unread) 'never)
130     ;; Set up the menu.
131     (when (gnus-visual-p 'pick-menu 'menu)
132       (gnus-pick-make-menu-bar)))))
133
134 (defun gnus-pick-setup-message ()
135   "Make Message do the right thing on exit."
136   (when (and (gnus-buffer-live-p gnus-summary-buffer)
137              (with-current-buffer gnus-summary-buffer
138                gnus-pick-mode))
139     (message-add-action
140      `(gnus-configure-windows ,gnus-current-window-configuration t)
141      'send 'exit 'postpone 'kill)))
142
143 (defvar gnus-pick-line-number 1)
144 (defun gnus-pick-line-number ()
145   "Return the current line number."
146   (if (bobp)
147       (setq gnus-pick-line-number 1)
148     (incf gnus-pick-line-number)))
149
150 (defun gnus-pick-start-reading (&optional catch-up)
151   "Start reading the picked articles.
152 If given a prefix, mark all unpicked articles as read."
153   (interactive "P")
154   (if gnus-newsgroup-processable
155       (progn
156         (gnus-summary-limit-to-articles nil)
157         (when (or catch-up gnus-mark-unpicked-articles-as-read)
158           (gnus-summary-limit-mark-excluded-as-read))
159         (gnus-summary-first-article)
160         (gnus-configure-windows
161          (if gnus-pick-display-summary 'article 'pick) t))
162     (if gnus-pick-elegant-flow
163         (progn
164           (when (or catch-up gnus-mark-unpicked-articles-as-read)
165             (gnus-summary-catchup nil t))
166           (if (gnus-group-quit-config gnus-newsgroup-name)
167               (gnus-summary-exit)
168             (gnus-summary-next-group)))
169       (error "No articles have been picked"))))
170
171 (defun gnus-pick-goto-article (arg)
172   "Go to the article number indicated by ARG.
173 If ARG is an invalid article number, then stay on current line."
174   (let (pos)
175     (save-excursion
176       (goto-char (point-min))
177       (when (zerop (forward-line (1- (prefix-numeric-value arg))))
178         (setq pos (point))))
179     (if (not pos)
180         (gnus-error 2 "No such line: %s" arg)
181       (goto-char pos))))
182
183 (defun gnus-pick-article (&optional arg)
184   "Pick the article on the current line.
185 If ARG, pick the article on that line instead."
186   (interactive "P")
187   (when arg
188     (gnus-pick-goto-article arg))
189   (gnus-summary-mark-as-processable 1))
190
191 (defun gnus-pick-article-or-thread (&optional arg)
192   "If `gnus-thread-hide-subtree' is t, then pick the thread on the current line.
193 Otherwise pick the article on the current line.
194 If ARG, pick the article/thread on that line instead."
195   (interactive "P")
196   (when arg
197     (gnus-pick-goto-article arg))
198   (if gnus-thread-hide-subtree
199       (progn
200         (save-excursion
201           (gnus-uu-mark-thread))
202         (forward-line 1))
203     (gnus-summary-mark-as-processable 1)))
204
205 (defun gnus-pick-unmark-article-or-thread (&optional arg)
206   "If `gnus-thread-hide-subtree' is t, then unmark the thread on current line.
207 Otherwise unmark the article on current line.
208 If ARG, unmark thread/article on that line instead."
209   (interactive "P")
210   (when arg
211     (gnus-pick-goto-article arg))
212   (if gnus-thread-hide-subtree
213       (save-excursion
214         (gnus-uu-unmark-thread))
215     (gnus-summary-unmark-as-processable 1)))
216
217 (defun gnus-pick-mouse-pick (e)
218   (interactive "e")
219   (mouse-set-point e)
220   (save-excursion
221     (gnus-summary-mark-as-processable 1)))
222
223 (defun gnus-pick-mouse-pick-region (start-event)
224   "Pick articles that the mouse is dragged over.
225 This must be bound to a button-down mouse event."
226   (interactive "e")
227   (mouse-minibuffer-check start-event)
228   (let* ((echo-keystrokes 0)
229          (start-posn (event-start start-event))
230          (start-point (posn-point start-posn))
231          (start-line (1+ (count-lines (point-min) start-point)))
232          (start-window (posn-window start-posn))
233          (bounds (gnus-window-edges start-window))
234          (top (nth 1 bounds))
235          (bottom (if (window-minibuffer-p start-window)
236                      (nth 3 bounds)
237                    ;; Don't count the mode line.
238                    (1- (nth 3 bounds))))
239          (click-count (1- (event-click-count start-event))))
240     (setq mouse-selection-click-count click-count)
241     (setq mouse-selection-click-count-buffer (current-buffer))
242     (mouse-set-point start-event)
243    ;; In case the down click is in the middle of some intangible text,
244     ;; use the end of that text, and put it in START-POINT.
245     (when (< (point) start-point)
246       (goto-char start-point))
247     (gnus-pick-article)
248     (setq start-point (point))
249     ;; end-of-range is used only in the single-click case.
250     ;; It is the place where the drag has reached so far
251     ;; (but not outside the window where the drag started).
252     (let (event end end-point (end-of-range (point)))
253       (track-mouse
254         (while (progn
255                  (setq event (cdr (gnus-read-event-char)))
256                  (or (mouse-movement-p event)
257                      (eq (car-safe event) 'switch-frame)))
258           (if (eq (car-safe event) 'switch-frame)
259               nil
260             (setq end (event-end event)
261                   end-point (posn-point end))
262
263             (cond
264              ;; Are we moving within the original window?
265              ((and (eq (posn-window end) start-window)
266                    (integer-or-marker-p end-point))
267               ;; Go to START-POINT first, so that when we move to END-POINT,
268               ;; if it's in the middle of intangible text,
269               ;; point jumps in the direction away from START-POINT.
270               (goto-char start-point)
271               (goto-char end-point)
272               (gnus-pick-article)
273               ;; In case the user moved his mouse really fast, pick
274               ;; articles on the line between this one and the last one.
275               (let* ((this-line (1+ (count-lines (point-min) end-point)))
276                      (min-line (min this-line start-line))
277                      (max-line (max this-line start-line)))
278                 (while (< min-line max-line)
279                   (goto-char (point-min))
280                   (forward-line (1- min-line))
281                   (gnus-pick-article)
282                   (setq min-line (1+ min-line)))
283                 (setq start-line this-line))
284               (when (zerop (% click-count 3))
285                 (setq end-of-range (point))))
286              (t
287               (let ((mouse-row (cdr (cdr (mouse-position)))))
288                 (cond
289                  ((null mouse-row))
290                  ((< mouse-row top)
291                   (mouse-scroll-subr start-window (- mouse-row top)))
292                  ((>= mouse-row bottom)
293                   (mouse-scroll-subr start-window
294                                      (1+ (- mouse-row bottom)))))))))))
295       (when (consp event)
296         (let ((fun (key-binding (vector (car event)))))
297           ;; Run the binding of the terminating up-event, if possible.
298        ;; In the case of a multiple click, it gives the wrong results,
299           ;; because it would fail to set up a region.
300           (when nil
301       ;; (and (= (mod mouse-selection-click-count 3) 0) (fboundp fun))
302        ;; In this case, we can just let the up-event execute normally.
303             (let ((end (event-end event)))
304               ;; Set the position in the event before we replay it,
305               ;; because otherwise it may have a position in the wrong
306               ;; buffer.
307               (setcar (cdr end) end-of-range)
308               ;; Delete the overlay before calling the function,
309              ;; because delete-overlay increases buffer-modified-tick.
310               (push event unread-command-events))))))))
311
312 (defun gnus-pick-next-page ()
313   "Go to the next page.  If at the end of the buffer, start reading articles."
314   (interactive)
315   (let ((scroll-in-place nil))
316     (condition-case nil
317         (scroll-up)
318       (end-of-buffer (gnus-pick-start-reading)))))
319
320 ;;;
321 ;;; gnus-binary-mode
322 ;;;
323
324 (defvar gnus-binary-mode-hook nil
325   "Hook run in summary binary mode buffers.")
326
327 (defvar gnus-binary-mode-map
328   (let ((map (make-sparse-keymap)))
329     (gnus-define-keys map
330       "g" gnus-binary-show-article)
331     map))
332
333 (defun gnus-binary-make-menu-bar ()
334   (unless (boundp 'gnus-binary-menu)
335     (easy-menu-define
336       gnus-binary-menu gnus-binary-mode-map ""
337       '("Pick"
338         ["Switch binary mode off" gnus-binary-mode t]))))
339
340 (eval-when-compile
341   (when (featurep 'xemacs)
342     (defvar gnus-binary-mode-on-hook)
343     (defvar gnus-binary-mode-off-hook)))
344
345 (define-minor-mode gnus-binary-mode
346   "Minor mode for providing a binary group interface in Gnus summary buffers."
347   :lighter " Binary" :keymap gnus-binary-mode-map
348   (cond
349    ((not (derived-mode-p 'gnus-summary-mode)) (setq gnus-binary-mode nil))
350    (gnus-binary-mode
351     ;; Make sure that we don't select any articles upon group entry.
352     (make-local-variable 'gnus-auto-select-first)
353     (setq gnus-auto-select-first nil)
354     (make-local-variable 'gnus-summary-display-article-function)
355     (setq gnus-summary-display-article-function 'gnus-binary-display-article)
356     ;; Set up the menu.
357     (when (gnus-visual-p 'binary-menu 'menu)
358       (gnus-binary-make-menu-bar)))))
359
360 (defun gnus-binary-display-article (article &optional all-header)
361   "Run ARTICLE through the binary decode functions."
362   (when (gnus-summary-goto-subject article)
363     (let ((gnus-view-pseudos (or gnus-view-pseudos 'automatic)))
364       (gnus-uu-decode-uu))))
365
366 (defun gnus-binary-show-article (&optional arg)
367   "Bypass the binary functions and show the article."
368   (interactive "P")
369   (let (gnus-summary-display-article-function)
370     (gnus-summary-show-article arg)))
371
372 ;;;
373 ;;; gnus-tree-mode
374 ;;;
375
376 (defcustom gnus-tree-line-format "%(%[%3,3n%]%)"
377   "Format of tree elements."
378   :type 'string
379   :group 'gnus-summary-tree)
380
381 (defcustom gnus-tree-minimize-window t
382   "If non-nil, minimize the tree buffer window.
383 If a number, never let the tree buffer grow taller than that number of
384 lines."
385   :type '(choice boolean
386                  integer)
387   :group 'gnus-summary-tree)
388
389 (defcustom gnus-selected-tree-face 'modeline
390   "*Face used for highlighting selected articles in the thread tree."
391   :type 'face
392   :group 'gnus-summary-tree)
393
394 (defvar gnus-tree-brackets '((?\[ . ?\]) (?\( . ?\))
395                              (?\{ . ?\}) (?< . ?>))
396   "Brackets used in tree nodes.")
397
398 (defvar gnus-tree-parent-child-edges '(?- ?\\ ?|)
399   "Characters used to connect parents with children.")
400
401 (defcustom gnus-tree-mode-line-format "Gnus: %%b %S %Z"
402   "*The format specification for the tree mode line."
403   :type 'string
404   :group 'gnus-summary-tree)
405
406 (defcustom gnus-generate-tree-function 'gnus-generate-vertical-tree
407   "*Function for generating a thread tree.
408 Two predefined functions are available:
409 `gnus-generate-horizontal-tree' and `gnus-generate-vertical-tree'."
410   :type '(radio (function-item gnus-generate-vertical-tree)
411                 (function-item gnus-generate-horizontal-tree)
412                 (function :tag "Other" nil))
413   :group 'gnus-summary-tree)
414
415 (defcustom gnus-tree-mode-hook nil
416   "*Hook run in tree mode buffers."
417   :type 'hook
418   :group 'gnus-summary-tree)
419
420 (when (featurep 'xemacs)
421   (add-hook 'gnus-tree-mode-hook 'gnus-xmas-tree-menu-add)
422   (add-hook 'gnus-tree-mode-hook 'gnus-xmas-switch-horizontal-scrollbar-off))
423
424
425 ;;; Internal variables.
426
427 (defvar gnus-tree-line-format-alist
428   `((?n gnus-tmp-name ?s)
429     (?f gnus-tmp-from ?s)
430     (?N gnus-tmp-number ?d)
431     (?\[ gnus-tmp-open-bracket ?c)
432     (?\] gnus-tmp-close-bracket ?c)
433     (?s gnus-tmp-subject ?s)))
434
435 (defvar gnus-tree-mode-line-format-alist gnus-summary-mode-line-format-alist)
436
437 (defvar gnus-tree-mode-line-format-spec nil)
438 (defvar gnus-tree-line-format-spec nil)
439
440 (defvar gnus-tree-node-length nil)
441 (defvar gnus-selected-tree-overlay nil)
442
443 (defvar gnus-tree-displayed-thread nil)
444 (defvar gnus-tree-inhibit nil)
445
446 (defvar gnus-tree-mode-map nil)
447 (put 'gnus-tree-mode 'mode-class 'special)
448
449 (unless gnus-tree-mode-map
450   (setq gnus-tree-mode-map (make-keymap))
451   (suppress-keymap gnus-tree-mode-map)
452   (gnus-define-keys
453       gnus-tree-mode-map
454     "\r" gnus-tree-select-article
455     gnus-mouse-2 gnus-tree-pick-article
456     "\C-?" gnus-tree-read-summary-keys
457     "h" gnus-tree-show-summary
458
459     "\C-c\C-i" gnus-info-find-node)
460
461   (substitute-key-definition
462    'undefined 'gnus-tree-read-summary-keys gnus-tree-mode-map))
463
464 (defun gnus-tree-make-menu-bar ()
465   (unless (boundp 'gnus-tree-menu)
466     (easy-menu-define
467       gnus-tree-menu gnus-tree-mode-map ""
468       '("Tree"
469         ["Select article" gnus-tree-select-article t]))))
470
471 (defun gnus-tree-mode ()
472   "Major mode for displaying thread trees."
473   (interactive)
474   (gnus-set-format 'tree-mode)
475   (gnus-set-format 'tree t)
476   (when (gnus-visual-p 'tree-menu 'menu)
477     (gnus-tree-make-menu-bar))
478   (kill-all-local-variables)
479   (gnus-simplify-mode-line)
480   (setq mode-name "Tree")
481   (setq major-mode 'gnus-tree-mode)
482   (use-local-map gnus-tree-mode-map)
483   (buffer-disable-undo)
484   (setq buffer-read-only t)
485   (setq truncate-lines t)
486   (save-excursion
487     (gnus-set-work-buffer)
488     (gnus-tree-node-insert (make-mail-header "") nil)
489     (setq gnus-tree-node-length (1- (point))))
490   (gnus-run-mode-hooks 'gnus-tree-mode-hook))
491
492 (defun gnus-tree-read-summary-keys (&optional arg)
493   "Read a summary buffer key sequence and execute it."
494   (interactive "P")
495   (unless gnus-tree-inhibit
496     (let ((buf (current-buffer))
497           (gnus-tree-inhibit t)
498           win)
499       (set-buffer gnus-article-buffer)
500       (gnus-article-read-summary-keys arg nil t)
501       (when (setq win (get-buffer-window buf))
502         (select-window win)
503         (when gnus-selected-tree-overlay
504           (goto-char (or (gnus-overlay-end gnus-selected-tree-overlay) 1)))
505         (gnus-tree-minimize)))))
506
507 (defun gnus-tree-show-summary ()
508   "Reconfigure windows to show summary buffer."
509   (interactive)
510   (if (not (gnus-buffer-live-p gnus-summary-buffer))
511       (error "There is no summary buffer for this tree buffer")
512     (gnus-configure-windows 'article)
513     (gnus-summary-goto-subject gnus-current-article)))
514
515 (defun gnus-tree-select-article (article)
516   "Select the article under point, if any."
517   (interactive (list (gnus-tree-article-number)))
518   (let ((buf (current-buffer)))
519     (when article
520       (with-current-buffer gnus-summary-buffer
521         (gnus-summary-goto-article article))
522       (select-window (get-buffer-window buf)))))
523
524 (defun gnus-tree-pick-article (e)
525   "Select the article under the mouse pointer."
526   (interactive "e")
527   (mouse-set-point e)
528   (gnus-tree-select-article (gnus-tree-article-number)))
529
530 (defun gnus-tree-article-number ()
531   (get-text-property (point) 'gnus-number))
532
533 (defun gnus-tree-article-region (article)
534   "Return a cons with BEG and END of the article region."
535   (let ((pos (text-property-any
536               (point-min) (point-max) 'gnus-number article)))
537     (when pos
538       (cons pos (next-single-property-change pos 'gnus-number)))))
539
540 (defun gnus-tree-goto-article (article)
541   (let ((pos (text-property-any
542               (point-min) (point-max) 'gnus-number article)))
543     (when pos
544       (goto-char pos))))
545
546 (defun gnus-tree-recenter ()
547   "Center point in the tree window."
548   (let ((selected (selected-window))
549         (tree-window (gnus-get-buffer-window gnus-tree-buffer t)))
550     (when tree-window
551       (select-window tree-window)
552       (when gnus-selected-tree-overlay
553         (goto-char (or (gnus-overlay-end gnus-selected-tree-overlay) 1)))
554       (let* ((top (cond ((< (window-height) 4) 0)
555                         ((< (window-height) 7) 1)
556                         (t 2)))
557              (height (1- (window-height)))
558              (bottom (save-excursion (goto-char (point-max))
559                                      (forward-line (- height))
560                                      (point))))
561       ;; Set the window start to either `bottom', which is the biggest
562         ;; possible valid number, or the second line from the top,
563         ;; whichever is the least.
564         (set-window-start
565          tree-window (min bottom (save-excursion
566                                    (forward-line (- top)) (point)))))
567       (select-window selected))))
568
569 (defun gnus-get-tree-buffer ()
570   "Return the tree buffer properly initialized."
571   (with-current-buffer (gnus-get-buffer-create gnus-tree-buffer)
572     (unless (eq major-mode 'gnus-tree-mode)
573       (gnus-tree-mode))
574     (current-buffer)))
575
576 (defun gnus-tree-minimize ()
577   (when (and gnus-tree-minimize-window
578              (not (one-window-p)))
579     (let ((windows 0)
580           tot-win-height)
581       (walk-windows (lambda (window) (incf windows)))
582       (setq tot-win-height
583             (- (frame-height)
584                (* window-min-height (1- windows))
585                2))
586       (let* ((window-min-height 2)
587              (height (count-lines (point-min) (point-max)))
588              (min (max (1- window-min-height) height))
589              (tot (if (numberp gnus-tree-minimize-window)
590                       (min gnus-tree-minimize-window min)
591                     min))
592              (win (get-buffer-window (current-buffer)))
593              (wh (and win (1- (window-height win)))))
594         (setq tot (min tot tot-win-height))
595         (when (and win
596                    (not (eq tot wh)))
597           (let ((selected (selected-window)))
598             (when (ignore-errors (select-window win))
599               (enlarge-window (- tot wh))
600               (select-window selected))))))))
601
602 ;;; Generating the tree.
603
604 (defun gnus-tree-node-insert (header sparse &optional adopted)
605   (let* ((dummy (stringp header))
606          (header (if (vectorp header) header
607                    (progn
608                      (setq header (make-mail-header "*****"))
609                      (mail-header-set-number header 0)
610                      (mail-header-set-lines header 0)
611                      (mail-header-set-chars header 0)
612                      header)))
613          (gnus-tmp-from (mail-header-from header))
614          (gnus-tmp-subject (mail-header-subject header))
615          (gnus-tmp-number (mail-header-number header))
616          (gnus-tmp-name
617           (cond
618            ((string-match "(.+)" gnus-tmp-from)
619             (substring gnus-tmp-from
620                        (1+ (match-beginning 0)) (1- (match-end 0))))
621            ((string-match "<[^>]+> *$" gnus-tmp-from)
622             (let ((beg (match-beginning 0)))
623               (or (and (string-match "^\"[^\"]*\"" gnus-tmp-from)
624                        (substring gnus-tmp-from (1+ (match-beginning 0))
625                                   (1- (match-end 0))))
626                   (substring gnus-tmp-from 0 beg))))
627            ((memq gnus-tmp-number sparse)
628             "***")
629            (t gnus-tmp-from)))
630          (gnus-tmp-open-bracket
631           (cond ((memq gnus-tmp-number sparse)
632                  (caadr gnus-tree-brackets))
633                 (dummy (caaddr gnus-tree-brackets))
634                 (adopted (car (nth 3 gnus-tree-brackets)))
635                 (t (caar gnus-tree-brackets))))
636          (gnus-tmp-close-bracket
637           (cond ((memq gnus-tmp-number sparse)
638                  (cdadr gnus-tree-brackets))
639                 (adopted (cdr (nth 3 gnus-tree-brackets)))
640                 (dummy
641                  (cdaddr gnus-tree-brackets))
642                 (t (cdar gnus-tree-brackets))))
643          (buffer-read-only nil)
644          beg end)
645     (gnus-add-text-properties
646      (setq beg (point))
647      (setq end (progn (eval gnus-tree-line-format-spec) (point)))
648      (list 'gnus-number gnus-tmp-number))
649     (when (or t (gnus-visual-p 'tree-highlight 'highlight))
650       (gnus-tree-highlight-node gnus-tmp-number beg end))))
651
652 (defun gnus-tree-highlight-node (article beg end)
653   "Highlight current line according to `gnus-summary-highlight'."
654   (let ((list gnus-summary-highlight)
655         face)
656     (with-current-buffer gnus-summary-buffer
657       (let* ((score (or (cdr (assq article gnus-newsgroup-scored))
658                         gnus-summary-default-score 0))
659              (default gnus-summary-default-score)
660              (default-high gnus-summary-default-high-score)
661              (default-low gnus-summary-default-low-score)
662              (uncached (memq article gnus-newsgroup-undownloaded))
663              (downloaded (not uncached))
664              (mark (or (gnus-summary-article-mark article) gnus-unread-mark)))
665         ;; Eval the cars of the lists until we find a match.
666         (while (and list
667                     (not (eval (caar list))))
668           (setq list (cdr list)))))
669     (unless (eq (setq face (cdar list)) (get-text-property beg 'face))
670       (gnus-put-text-property-excluding-characters-with-faces
671        beg end 'face
672        (if (boundp face) (symbol-value face) face)))))
673
674 (defun gnus-tree-indent (level)
675   (insert (make-string (1- (* (1+ gnus-tree-node-length) level)) ? )))
676
677 (defvar gnus-tmp-limit)
678 (defvar gnus-tmp-sparse)
679 (defvar gnus-tmp-indent)
680
681 (defun gnus-generate-tree (thread)
682   "Generate a thread tree for THREAD."
683   (with-current-buffer (gnus-get-tree-buffer)
684     (let ((buffer-read-only nil)
685           (gnus-tmp-indent 0))
686       (erase-buffer)
687       (funcall gnus-generate-tree-function thread 0)
688       (gnus-set-mode-line 'tree)
689       (goto-char (point-min))
690       (gnus-tree-minimize)
691       (gnus-tree-recenter)
692       (let ((selected (selected-window)))
693         (when (gnus-get-buffer-window (set-buffer gnus-tree-buffer) t)
694           (select-window (gnus-get-buffer-window (set-buffer gnus-tree-buffer) t))
695           (gnus-horizontal-recenter)
696           (select-window selected))))))
697
698 (defun gnus-generate-horizontal-tree (thread level &optional dummyp adopted)
699   "Generate a horizontal tree."
700   (let* ((dummy (stringp (car thread)))
701          (do (or dummy
702                  (and (car thread)
703                       (memq (mail-header-number (car thread))
704                             gnus-tmp-limit))))
705          col beg)
706     (if (not do)
707         ;; We don't want this article.
708         (setq thread (cdr thread))
709       (if (not (bolp))
710           ;; Not the first article on the line, so we insert a "-".
711           (insert (car gnus-tree-parent-child-edges))
712         ;; If the level isn't zero, then we insert some indentation.
713         (unless (zerop level)
714           (gnus-tree-indent level)
715           (insert (cadr gnus-tree-parent-child-edges))
716           (setq col (- (setq beg (point)) (point-at-bol) 1))
717           ;; Draw "|" lines upwards.
718           (while (progn
719                    (forward-line -1)
720                    (forward-char col)
721                    (eq (char-after) ? ))
722             (delete-char 1)
723             (insert (caddr gnus-tree-parent-child-edges)))
724           (goto-char beg)))
725       (setq dummyp nil)
726       ;; Insert the article node.
727       (gnus-tree-node-insert (pop thread) gnus-tmp-sparse adopted))
728     (if (null thread)
729         ;; End of the thread, so we go to the next line.
730         (unless (bolp)
731           (insert "\n"))
732       ;; Recurse downwards in all children of this article.
733       (while thread
734         (gnus-generate-horizontal-tree
735          (pop thread) (if do (1+ level) level)
736          (or dummyp dummy) dummy)))))
737
738 (defsubst gnus-tree-indent-vertical ()
739   (let ((len (- (* (1+ gnus-tree-node-length) gnus-tmp-indent)
740                 (- (point) (point-at-bol)))))
741     (when (> len 0)
742       (insert (make-string len ? )))))
743
744 (defsubst gnus-tree-forward-line (n)
745   (while (>= (decf n) 0)
746     (unless (zerop (forward-line 1))
747       (end-of-line)
748       (insert "\n")))
749   (end-of-line))
750
751 (defun gnus-generate-vertical-tree (thread level &optional dummyp adopted)
752   "Generate a vertical tree."
753   (let* ((dummy (stringp (car thread)))
754          (do (or dummy
755                  (and (car thread)
756                       (memq (mail-header-number (car thread))
757                             gnus-tmp-limit))))
758          beg)
759     (if (not do)
760         ;; We don't want this article.
761         (setq thread (cdr thread))
762       (if (not (save-excursion (beginning-of-line) (bobp)))
763           ;; Not the first article on the line, so we insert a "-".
764           (progn
765             (gnus-tree-indent-vertical)
766             (insert (make-string (/ gnus-tree-node-length 2) ? ))
767             (insert (caddr gnus-tree-parent-child-edges))
768             (gnus-tree-forward-line 1))
769         ;; If the level isn't zero, then we insert some indentation.
770         (unless (zerop gnus-tmp-indent)
771           (gnus-tree-forward-line (1- (* 2 level)))
772           (gnus-tree-indent-vertical)
773           (delete-char -1)
774           (insert (cadr gnus-tree-parent-child-edges))
775           (setq beg (point))
776           (forward-char -1)
777           ;; Draw "-" lines leftwards.
778           (while (and (not (bobp))
779                       (eq (char-after (1- (point))) ? ))
780             (delete-char -1)
781             (insert (car gnus-tree-parent-child-edges))
782             (forward-char -1))
783           (goto-char beg)
784           (gnus-tree-forward-line 1)))
785       (setq dummyp nil)
786       ;; Insert the article node.
787       (gnus-tree-indent-vertical)
788       (gnus-tree-node-insert (pop thread) gnus-tmp-sparse adopted)
789       (gnus-tree-forward-line 1))
790     (if (null thread)
791         ;; End of the thread, so we go to the next line.
792         (progn
793           (goto-char (point-min))
794           (end-of-line)
795           (incf gnus-tmp-indent))
796       ;; Recurse downwards in all children of this article.
797       (while thread
798         (gnus-generate-vertical-tree
799          (pop thread) (if do (1+ level) level)
800          (or dummyp dummy) dummy)))))
801
802 ;;; Interface functions.
803
804 (defun gnus-possibly-generate-tree (article &optional force)
805   "Generate the thread tree for ARTICLE if it isn't displayed already."
806   (when (with-current-buffer gnus-summary-buffer
807           (and gnus-use-trees
808                gnus-show-threads
809                (vectorp (gnus-summary-article-header article))))
810     (save-excursion
811       (let ((top (with-current-buffer gnus-summary-buffer
812                    (gnus-cut-thread
813                     (gnus-remove-thread
814                      (mail-header-id
815                       (gnus-summary-article-header article))
816                      t))))
817             (gnus-tmp-limit gnus-newsgroup-limit)
818             (gnus-tmp-sparse gnus-newsgroup-sparse))
819         (when (or force
820                   (not (eq top gnus-tree-displayed-thread)))
821           (gnus-generate-tree top)
822           (setq gnus-tree-displayed-thread top))))))
823
824 (defun gnus-tree-open (group)
825   (gnus-get-tree-buffer))
826
827 (defun gnus-tree-close (group)
828   (gnus-kill-buffer gnus-tree-buffer))
829
830 (defun gnus-tree-perhaps-minimize ()
831   (when (and gnus-tree-minimize-window
832              (get-buffer gnus-tree-buffer))
833     (with-current-buffer gnus-tree-buffer
834       (gnus-tree-minimize))))
835
836 (defun gnus-highlight-selected-tree (article)
837   "Highlight the selected article in the tree."
838   (let ((buf (current-buffer))
839         region)
840     (set-buffer gnus-tree-buffer)
841     (when (setq region (gnus-tree-article-region article))
842       (when (or (not gnus-selected-tree-overlay)
843                 (gnus-extent-detached-p gnus-selected-tree-overlay))
844         ;; Create a new overlay.
845         (gnus-overlay-put
846          (setq gnus-selected-tree-overlay
847                (gnus-make-overlay (point-min) (1+ (point-min))))
848          'face gnus-selected-tree-face))
849       ;; Move the overlay to the article.
850       (gnus-move-overlay
851        gnus-selected-tree-overlay (goto-char (car region)) (cdr region))
852       (gnus-tree-minimize)
853       (gnus-tree-recenter)
854       (let ((selected (selected-window)))
855         (when (gnus-get-buffer-window (set-buffer gnus-tree-buffer) t)
856           (select-window (gnus-get-buffer-window (set-buffer gnus-tree-buffer) t))
857           (gnus-horizontal-recenter)
858           (select-window selected))))
859 ;; If we remove this save-excursion, it updates the wrong mode lines?!?
860     (with-current-buffer gnus-tree-buffer
861       (gnus-set-mode-line 'tree))
862     (set-buffer buf)))
863
864 (defun gnus-tree-highlight-article (article face)
865   (with-current-buffer (gnus-get-tree-buffer)
866     (let (region)
867       (when (setq region (gnus-tree-article-region article))
868         (gnus-put-text-property (car region) (cdr region) 'face face)
869         (set-window-point
870          (gnus-get-buffer-window (current-buffer) t) (cdr region))))))
871
872 ;;;
873 ;;; gnus-carpal
874 ;;;
875
876 (defvar gnus-carpal-group-buffer-buttons
877   '(("next" . gnus-group-next-unread-group)
878     ("prev" . gnus-group-prev-unread-group)
879     ("read" . gnus-group-read-group)
880     ("select" . gnus-group-select-group)
881     ("catch-up" . gnus-group-catchup-current)
882     ("new-news" . gnus-group-get-new-news-this-group)
883     ("toggle-sub" . gnus-group-unsubscribe-current-group)
884     ("subscribe" . gnus-group-unsubscribe-group)
885     ("kill" . gnus-group-kill-group)
886     ("yank" . gnus-group-yank-group)
887     ("describe" . gnus-group-describe-group)
888     "list"
889     ("subscribed" . gnus-group-list-groups)
890     ("all" . gnus-group-list-all-groups)
891     ("killed" . gnus-group-list-killed)
892     ("zombies" . gnus-group-list-zombies)
893     ("matching" . gnus-group-list-matching)
894     ("post" . gnus-group-post-news)
895     ("mail" . gnus-group-mail)
896     ("local" . (lambda () (interactive) (gnus-group-news 0)))
897     ("rescan" . gnus-group-get-new-news)
898     ("browse-foreign" . gnus-group-browse-foreign)
899     ("exit" . gnus-group-exit)))
900
901 (defvar gnus-carpal-summary-buffer-buttons
902   '("mark"
903     ("read" . gnus-summary-mark-as-read-forward)
904     ("tick" . gnus-summary-tick-article-forward)
905     ("clear" . gnus-summary-clear-mark-forward)
906     ("expirable" . gnus-summary-mark-as-expirable)
907     "move"
908     ("scroll" . gnus-summary-next-page)
909     ("next-unread" . gnus-summary-next-unread-article)
910     ("prev-unread" . gnus-summary-prev-unread-article)
911     ("first" . gnus-summary-first-unread-article)
912     ("best" . gnus-summary-best-unread-article)
913     "article"
914     ("headers" . gnus-summary-toggle-header)
915     ("uudecode" . gnus-uu-decode-uu)
916     ("enter-digest" . gnus-summary-enter-digest-group)
917     ("fetch-parent" . gnus-summary-refer-parent-article)
918     "mail"
919     ("move" . gnus-summary-move-article)
920     ("copy" . gnus-summary-copy-article)
921     ("respool" . gnus-summary-respool-article)
922     "threads"
923     ("lower" . gnus-summary-lower-thread)
924     ("kill" . gnus-summary-kill-thread)
925     "post"
926     ("post" . gnus-summary-post-news)
927     ("local" . gnus-summary-news-other-window)
928     ("mail" . gnus-summary-mail-other-window)
929     ("followup" . gnus-summary-followup-with-original)
930     ("reply" . gnus-summary-reply-with-original)
931     ("cancel" . gnus-summary-cancel-article)
932     "misc"
933     ("exit" . gnus-summary-exit)
934     ("fed-up" . gnus-summary-catchup-and-goto-next-group)))
935
936 (defvar gnus-carpal-server-buffer-buttons
937   '(("add" . gnus-server-add-server)
938     ("browse" . gnus-server-browse-server)
939     ("list" . gnus-server-list-servers)
940     ("kill" . gnus-server-kill-server)
941     ("yank" . gnus-server-yank-server)
942     ("copy" . gnus-server-copy-server)
943     ("exit" . gnus-server-exit)))
944
945 (defvar gnus-carpal-browse-buffer-buttons
946   '(("subscribe" . gnus-browse-unsubscribe-current-group)
947     ("exit" . gnus-browse-exit)))
948
949 (defvar gnus-carpal-group-buffer "*Carpal Group*")
950 (defvar gnus-carpal-summary-buffer "*Carpal Summary*")
951 (defvar gnus-carpal-server-buffer "*Carpal Server*")
952 (defvar gnus-carpal-browse-buffer "*Carpal Browse*")
953
954 (defvar gnus-carpal-attached-buffer nil)
955
956 (defvar gnus-carpal-mode-hook nil
957   "*Hook run in carpal mode buffers.")
958
959 (defvar gnus-carpal-button-face 'bold
960   "*Face used on carpal buttons.")
961
962 (defvar gnus-carpal-header-face 'bold-italic
963   "*Face used on carpal buffer headers.")
964
965 (defvar gnus-carpal-mode-map nil)
966 (put 'gnus-carpal-mode 'mode-class 'special)
967
968 (if gnus-carpal-mode-map
969     nil
970   (setq gnus-carpal-mode-map (make-keymap))
971   (suppress-keymap gnus-carpal-mode-map)
972   (define-key gnus-carpal-mode-map " " 'gnus-carpal-select)
973   (define-key gnus-carpal-mode-map "\r" 'gnus-carpal-select)
974   (define-key gnus-carpal-mode-map gnus-mouse-2 'gnus-carpal-mouse-select))
975
976 (defun gnus-carpal-mode ()
977   "Major mode for clicking buttons.
978
979 All normal editing commands are switched off.
980 \\<gnus-carpal-mode-map>
981 The following commands are available:
982
983 \\{gnus-carpal-mode-map}"
984   (interactive)
985   (kill-all-local-variables)
986   (setq mode-line-modified (cdr gnus-mode-line-modified))
987   (setq major-mode 'gnus-carpal-mode)
988   (setq mode-name "Gnus Carpal")
989   (setq mode-line-process nil)
990   (use-local-map gnus-carpal-mode-map)
991   (buffer-disable-undo)
992   (setq buffer-read-only t)
993   (make-local-variable 'gnus-carpal-attached-buffer)
994   (gnus-run-mode-hooks 'gnus-carpal-mode-hook))
995
996 (defun gnus-carpal-setup-buffer (type)
997   (let ((buffer (symbol-value (intern (format "gnus-carpal-%s-buffer" type)))))
998     (if (get-buffer buffer)
999         ()
1000       (with-current-buffer (gnus-get-buffer-create buffer)
1001         (gnus-carpal-mode)
1002         (setq gnus-carpal-attached-buffer
1003               (intern (format "gnus-%s-buffer" type)))
1004         (let ((buttons (symbol-value
1005                         (intern (format "gnus-carpal-%s-buffer-buttons"
1006                                         type))))
1007               (buffer-read-only nil)
1008               button)
1009           (while buttons
1010             (setq button (car buttons)
1011                   buttons (cdr buttons))
1012             (if (stringp button)
1013                 (set-text-properties
1014                  (point)
1015                  (prog2 (insert button) (point) (insert " "))
1016                  (list 'face gnus-carpal-header-face))
1017               (set-text-properties
1018                (point)
1019                (prog2 (insert (car button)) (point) (insert " "))
1020                (list 'gnus-callback (cdr button)
1021                      'face gnus-carpal-button-face
1022                      gnus-mouse-face-prop 'highlight))))
1023           (let ((fill-column (- (window-width) 2)))
1024             (fill-region (point-min) (point-max)))
1025           (set-window-point (get-buffer-window (current-buffer))
1026                             (point-min)))))))
1027
1028 (defun gnus-carpal-select ()
1029   "Select the button under point."
1030   (interactive)
1031   (let ((func (get-text-property (point) 'gnus-callback)))
1032     (if (null func)
1033         ()
1034       (pop-to-buffer (symbol-value gnus-carpal-attached-buffer))
1035       (call-interactively func))))
1036
1037 (defun gnus-carpal-mouse-select (event)
1038   "Select the button under the mouse pointer."
1039   (interactive "e")
1040   (mouse-set-point event)
1041   (gnus-carpal-select))
1042
1043 ;;; Allow redefinition of functions.
1044 (gnus-ems-redefine)
1045
1046 (provide 'gnus-salt)
1047
1048 ;; arch-tag: 35449164-77b3-4398-bcbd-a2e3e998f810
1049 ;;; gnus-salt.el ends here