1 ;;; gnus-salt.el --- alternate summary mode interfaces for Gnus
2 ;; Copyright (C) 1996 Free Software Foundation, Inc.
4 ;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
6 ;; This file is part of GNU Emacs.
8 ;; GNU Emacs is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; GNU Emacs is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; You should have received a copy of the GNU General Public License
19 ;; along with GNU Emacs; see the file COPYING. If not, write to the
20 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 ;; Boston, MA 02111-1307, USA.
28 (eval-when-compile (require 'cl))
34 (defvar gnus-pick-mode nil
35 "Minor mode for providing a pick-and-read interface in Gnus summary buffers.")
37 (defvar gnus-pick-display-summary nil
38 "*Display summary while reading.")
40 (defvar gnus-pick-mode-hook nil
41 "Hook run in summary pick mode buffers.")
43 ;;; Internal variables.
45 (defvar gnus-pick-mode-map nil)
47 (unless gnus-pick-mode-map
48 (setq gnus-pick-mode-map (make-sparse-keymap))
52 "t" gnus-uu-mark-thread
53 "T" gnus-uu-unmark-thread
54 " " gnus-summary-mark-as-processable
55 "u" gnus-summary-unmark-as-processable
56 "U" gnus-summary-unmark-all-processable
58 "r" gnus-uu-mark-region
59 "R" gnus-uu-unmark-region
60 "e" gnus-uu-mark-by-regexp
61 "E" gnus-uu-mark-by-regexp
62 "b" gnus-uu-mark-buffer
63 "B" gnus-uu-unmark-buffer
64 "\r" gnus-pick-start-reading))
66 (defun gnus-pick-make-menu-bar ()
67 (unless (boundp 'gnus-pick-menu)
69 gnus-pick-menu gnus-pick-mode-map ""
72 ["Article" gnus-summary-mark-as-processable t]
73 ["Thread" gnus-uu-mark-thread t]
74 ["Region" gnus-uu-mark-region t]
75 ["Regexp" gnus-uu-mark-regexp t]
76 ["Buffer" gnus-uu-mark-buffer t])
78 ["Article" gnus-summary-unmark-as-processable t]
79 ["Thread" gnus-uu-unmark-thread t]
80 ["Region" gnus-uu-unmark-region t]
81 ["Regexp" gnus-uu-unmark-regexp t]
82 ["Buffer" gnus-uu-unmark-buffer t])
83 ["Start reading" gnus-pick-start-reading t]
84 ["Switch pick mode off" gnus-pick-mode gnus-pick-mode]))))
86 (defun gnus-pick-mode (&optional arg)
87 "Minor mode for providing a pick-and-read interface in Gnus summary buffers."
89 (when (eq major-mode 'gnus-summary-mode)
90 (make-local-variable 'gnus-pick-mode)
92 (if (null arg) (not gnus-pick-mode)
93 (> (prefix-numeric-value arg) 0)))
95 ;; Make sure that we don't select any articles upon group entry.
96 (make-local-variable 'gnus-auto-select-first)
97 (setq gnus-auto-select-first nil)
99 (when (and menu-bar-mode
100 (gnus-visual-p 'pick-menu 'menu))
101 (gnus-pick-make-menu-bar))
102 (unless (assq 'gnus-pick-mode minor-mode-alist)
103 (push '(gnus-pick-mode " Pick") minor-mode-alist))
104 (unless (assq 'gnus-pick-mode minor-mode-map-alist)
105 (push (cons 'gnus-pick-mode gnus-pick-mode-map)
106 minor-mode-map-alist))
107 (run-hooks 'gnus-pick-mode-hook))))
109 (defun gnus-pick-start-reading (&optional catch-up)
110 "Start reading the picked articles.
111 If given a prefix, mark all unpicked articles as read."
113 (unless gnus-newsgroup-processable
114 (error "No articles have been picked"))
115 (gnus-summary-limit-to-articles nil)
117 (gnus-summary-limit-mark-excluded-as-read))
118 (gnus-configure-windows (if gnus-pick-display-summary 'summary 'pick) t))
125 (defvar gnus-binary-mode nil
126 "Minor mode for provind a binary group interface in Gnus summary buffers.")
128 (defvar gnus-binary-mode-hook nil
129 "Hook run in summary binary mode buffers.")
131 (defvar gnus-binary-mode-map nil)
133 (unless gnus-binary-mode-map
134 (setq gnus-binary-mode-map (make-sparse-keymap))
138 "g" gnus-binary-show-article))
140 (defun gnus-binary-make-menu-bar ()
141 (unless (boundp 'gnus-binary-menu)
143 gnus-binary-menu gnus-binary-mode-map ""
145 ["Switch binary mode off" gnus-binary-mode t]))))
147 (defun gnus-binary-mode (&optional arg)
148 "Minor mode for providing a binary group interface in Gnus summary buffers."
150 (when (eq major-mode 'gnus-summary-mode)
151 (make-local-variable 'gnus-binary-mode)
152 (setq gnus-binary-mode
153 (if (null arg) (not gnus-binary-mode)
154 (> (prefix-numeric-value arg) 0)))
155 (when gnus-binary-mode
156 ;; Make sure that we don't select any articles upon group entry.
157 (make-local-variable 'gnus-auto-select-first)
158 (setq gnus-auto-select-first nil)
159 (make-local-variable 'gnus-summary-display-article-function)
160 (setq gnus-summary-display-article-function 'gnus-binary-display-article)
162 (when (and menu-bar-mode
163 (gnus-visual-p 'binary-menu 'menu))
164 (gnus-binary-make-menu-bar))
165 (unless (assq 'gnus-binary-mode minor-mode-alist)
166 (push '(gnus-binary-mode " Binary") minor-mode-alist))
167 (unless (assq 'gnus-topic-mode minor-mode-map-alist)
168 (push (cons 'gnus-topic-mode gnus-binary-mode-map)
169 minor-mode-map-alist))
170 (run-hooks 'gnus-binary-mode-hook))))
172 (defun gnus-binary-display-article (article &optional all-header)
173 "Run ARTICLE through the binary decode functions."
174 (when (gnus-summary-goto-subject article)
175 (let ((gnus-view-pseudos 'automatic))
176 (gnus-uu-decode-uu))))
178 (defun gnus-binary-show-article (&optional arg)
179 "Bypass the binary functions and show the article."
181 (let (gnus-summary-display-article-function)
182 (gnus-summary-show-article arg)))
188 (defvar gnus-tree-line-format "%(%[%3,3n%]%)"
189 "Format of tree elements.")
191 (defvar gnus-tree-minimize-window t
192 "If non-nil, minimize the tree buffer window.
193 If a number, never let the tree buffer grow taller than that number of
196 (defvar gnus-selected-tree-face 'modeline
197 "*Face used for highlighting selected articles in the thread tree.")
199 (defvar gnus-tree-brackets '((?\[ . ?\]) (?\( . ?\))
200 (?\{ . ?\}) (?< . ?>))
201 "Brackets used in tree nodes.")
203 (defvar gnus-tree-parent-child-edges '(?- ?\\ ?|)
204 "Charaters used to connect parents with children.")
206 (defvar gnus-tree-mode-line-format "Gnus: %%b %S %Z"
207 "*The format specification for the tree mode line.")
209 (defvar gnus-generate-tree-function 'gnus-generate-vertical-tree
210 "*Function for generating a thread tree.
211 Two predefined functions are available:
212 `gnus-generate-horizontal-tree' and `gnus-generate-vertical-tree'.")
214 (defvar gnus-tree-mode-hook nil
215 "*Hook run in tree mode buffers.")
217 (defvar gnus-tree-buffer "*Tree*"
218 "Buffer where Gnus thread trees are displayed.")
220 ;;; Internal variables.
222 (defvar gnus-tree-line-format-alist
223 `((?n gnus-tmp-name ?s)
224 (?f gnus-tmp-from ?s)
225 (?N gnus-tmp-number ?d)
226 (?\[ gnus-tmp-open-bracket ?c)
227 (?\] gnus-tmp-close-bracket ?c)
228 (?s gnus-tmp-subject ?s)))
230 (defvar gnus-tree-mode-line-format-alist gnus-summary-mode-line-format-alist)
232 (defvar gnus-tree-mode-line-format-spec nil)
233 (defvar gnus-tree-line-format-spec nil)
235 (defvar gnus-tree-node-length nil)
236 (defvar gnus-selected-tree-overlay nil)
238 (defvar gnus-tree-displayed-thread nil)
240 (defvar gnus-tree-mode-map nil)
241 (put 'gnus-tree-mode 'mode-class 'special)
243 (unless gnus-tree-mode-map
244 (setq gnus-tree-mode-map (make-keymap))
245 (suppress-keymap gnus-tree-mode-map)
248 "\r" gnus-tree-select-article
249 gnus-mouse-2 gnus-tree-pick-article
250 "\C-?" gnus-tree-read-summary-keys)
252 (substitute-key-definition
253 'undefined 'gnus-tree-read-summary-keys gnus-tree-mode-map))
255 (defun gnus-tree-make-menu-bar ()
258 (defun gnus-tree-mode ()
259 "Major mode for displaying thread trees."
261 (setq gnus-tree-mode-line-format-spec
262 (gnus-parse-format gnus-tree-mode-line-format
263 gnus-summary-mode-line-format-alist))
264 (setq gnus-tree-line-format-spec
265 (gnus-parse-format gnus-tree-line-format
266 gnus-tree-line-format-alist t))
267 (when (and menu-bar-mode
268 (gnus-visual-p 'tree-menu 'menu))
269 (gnus-tree-make-menu-bar))
270 (kill-all-local-variables)
271 (gnus-simplify-mode-line)
272 (setq mode-name "Tree")
273 (setq major-mode 'gnus-tree-mode)
274 (use-local-map gnus-tree-mode-map)
275 (buffer-disable-undo (current-buffer))
276 (setq buffer-read-only t)
277 (setq truncate-lines t)
279 (gnus-set-work-buffer)
280 (gnus-tree-node-insert (make-mail-header "") nil)
281 (setq gnus-tree-node-length (1- (point))))
282 (run-hooks 'gnus-tree-mode-hook))
284 (defun gnus-tree-read-summary-keys (&optional arg)
285 "Read a summary buffer key sequence and execute it."
287 (let ((buf (current-buffer))
289 (gnus-article-read-summary-keys arg nil t)
290 (when (setq win (get-buffer-window buf))
292 (when gnus-selected-tree-overlay
293 (goto-char (or (gnus-overlay-end gnus-selected-tree-overlay) 1)))
294 (gnus-tree-minimize))))
296 (defun gnus-tree-select-article (article)
297 "Select the article under point, if any."
298 (interactive (list (gnus-tree-article-number)))
299 (let ((buf (current-buffer)))
302 (set-buffer gnus-summary-buffer)
303 (gnus-summary-goto-article article))
304 (select-window (get-buffer-window buf)))))
306 (defun gnus-tree-pick-article (e)
307 "Select the article under the mouse pointer."
310 (gnus-tree-select-article (gnus-tree-article-number)))
312 (defun gnus-tree-article-number ()
313 (get-text-property (point) 'gnus-number))
315 (defun gnus-tree-article-region (article)
316 "Return a cons with BEG and END of the article region."
317 (let ((pos (text-property-any (point-min) (point-max) 'gnus-number article)))
319 (cons pos (next-single-property-change pos 'gnus-number)))))
321 (defun gnus-tree-goto-article (article)
322 (let ((pos (text-property-any (point-min) (point-max) 'gnus-number article)))
326 (defun gnus-tree-recenter ()
327 "Center point in the tree window."
328 (let ((selected (selected-window))
329 (tree-window (get-buffer-window gnus-tree-buffer t)))
331 (select-window tree-window)
332 (when gnus-selected-tree-overlay
333 (goto-char (or (gnus-overlay-end gnus-selected-tree-overlay) 1)))
334 (let* ((top (cond ((< (window-height) 4) 0)
335 ((< (window-height) 7) 1)
337 (height (1- (window-height)))
338 (bottom (save-excursion (goto-char (point-max))
339 (forward-line (- height))
341 ;; Set the window start to either `bottom', which is the biggest
342 ;; possible valid number, or the second line from the top,
343 ;; whichever is the least.
345 tree-window (min bottom (save-excursion
346 (forward-line (- top)) (point)))))
347 (select-window selected))))
349 (defun gnus-get-tree-buffer ()
350 "Return the tree buffer properly initialized."
352 (set-buffer (get-buffer-create gnus-tree-buffer))
353 (unless (eq major-mode 'gnus-tree-mode)
354 (gnus-add-current-to-buffer-list)
358 (defun gnus-tree-minimize ()
359 (when (and gnus-tree-minimize-window
360 (not (one-window-p)))
361 (let* ((window-min-height 2)
362 (height (count-lines (point-min) (point-max)))
363 (min (max (1- window-min-height) height))
364 (tot (if (numberp gnus-tree-minimize-window)
365 (min gnus-tree-minimize-window min)
367 (win (get-buffer-window (current-buffer)))
368 (wh (and win (1- (window-height win)))))
371 (let ((selected (selected-window)))
373 (enlarge-window (- tot wh))
374 (select-window selected))))))
376 ;;; Generating the tree.
378 (defun gnus-tree-node-insert (header sparse &optional adopted)
379 (let* ((dummy (stringp header))
380 (header (if (vectorp header) header
382 (setq header (make-mail-header "*****"))
383 (mail-header-set-number header 0)
384 (mail-header-set-lines header 0)
385 (mail-header-set-chars header 0)
387 (gnus-tmp-from (mail-header-from header))
388 (gnus-tmp-subject (mail-header-subject header))
389 (gnus-tmp-number (mail-header-number header))
392 ((string-match "(.+)" gnus-tmp-from)
393 (substring gnus-tmp-from
394 (1+ (match-beginning 0)) (1- (match-end 0))))
395 ((string-match "<[^>]+> *$" gnus-tmp-from)
396 (let ((beg (match-beginning 0)))
397 (or (and (string-match "^\"[^\"]*\"" gnus-tmp-from)
398 (substring gnus-tmp-from (1+ (match-beginning 0))
400 (substring gnus-tmp-from 0 beg))))
401 ((memq gnus-tmp-number sparse)
404 (gnus-tmp-open-bracket
405 (cond ((memq gnus-tmp-number sparse)
406 (caadr gnus-tree-brackets))
407 (dummy (caaddr gnus-tree-brackets))
408 (adopted (car (nth 3 gnus-tree-brackets)))
409 (t (caar gnus-tree-brackets))))
410 (gnus-tmp-close-bracket
411 (cond ((memq gnus-tmp-number sparse)
412 (cdadr gnus-tree-brackets))
413 (adopted (cdr (nth 3 gnus-tree-brackets)))
415 (cdaddr gnus-tree-brackets))
416 (t (cdar gnus-tree-brackets))))
417 (buffer-read-only nil)
421 (setq end (progn (eval gnus-tree-line-format-spec) (point)))
422 (list 'gnus-number gnus-tmp-number))
423 (when (or t (gnus-visual-p 'tree-highlight 'highlight))
424 (gnus-tree-highlight-node gnus-tmp-number beg end))))
426 (defun gnus-tree-highlight-node (article beg end)
427 "Highlight current line according to `gnus-summary-highlight'."
428 (let ((list gnus-summary-highlight)
431 (set-buffer gnus-summary-buffer)
432 (let* ((score (or (cdr (assq article gnus-newsgroup-scored))
433 gnus-summary-default-score 0))
434 (default gnus-summary-default-score)
435 (mark (or (gnus-summary-article-mark article) gnus-unread-mark)))
436 ;; Eval the cars of the lists until we find a match.
438 (not (eval (caar list))))
439 (setq list (cdr list)))))
440 (unless (eq (setq face (cdar list)) (get-text-property beg 'face))
443 (if (boundp face) (symbol-value face) face)))))
445 (defun gnus-tree-indent (level)
446 (insert (make-string (1- (* (1+ gnus-tree-node-length) level)) ? )))
448 (defvar gnus-tmp-limit)
449 (defvar gnus-tmp-sparse)
450 (defvar gnus-tmp-indent)
452 (defun gnus-generate-tree (thread)
453 "Generate a thread tree for THREAD."
455 (set-buffer (gnus-get-tree-buffer))
456 (let ((buffer-read-only nil)
459 (funcall gnus-generate-tree-function thread 0)
460 (gnus-set-mode-line 'tree)
461 (goto-char (point-min))
464 (let ((selected (selected-window)))
465 (when (get-buffer-window (set-buffer gnus-tree-buffer) t)
466 (select-window (get-buffer-window (set-buffer gnus-tree-buffer) t))
467 (gnus-horizontal-recenter)
468 (select-window selected))))))
470 (defun gnus-generate-horizontal-tree (thread level &optional dummyp adopted)
471 "Generate a horizontal tree."
472 (let* ((dummy (stringp (car thread)))
474 (memq (mail-header-number (car thread)) gnus-tmp-limit)))
477 ;; We don't want this article.
478 (setq thread (cdr thread))
480 ;; Not the first article on the line, so we insert a "-".
481 (insert (car gnus-tree-parent-child-edges))
482 ;; If the level isn't zero, then we insert some indentation.
483 (unless (zerop level)
484 (gnus-tree-indent level)
485 (insert (cadr gnus-tree-parent-child-edges))
486 (setq col (- (setq beg (point)) (gnus-point-at-bol) 1))
487 ;; Draw "|" lines upwards.
491 (= (following-char) ? ))
493 (insert (caddr gnus-tree-parent-child-edges)))
496 ;; Insert the article node.
497 (gnus-tree-node-insert (pop thread) gnus-tmp-sparse adopted))
499 ;; End of the thread, so we go to the next line.
502 ;; Recurse downwards in all children of this article.
504 (gnus-generate-horizontal-tree
505 (pop thread) (if do (1+ level) level)
506 (or dummyp dummy) dummy)))))
508 (defsubst gnus-tree-indent-vertical ()
509 (let ((len (- (* (1+ gnus-tree-node-length) gnus-tmp-indent)
510 (- (point) (gnus-point-at-bol)))))
512 (insert (make-string len ? )))))
514 (defsubst gnus-tree-forward-line (n)
515 (while (>= (decf n) 0)
516 (unless (zerop (forward-line 1))
521 (defun gnus-generate-vertical-tree (thread level &optional dummyp adopted)
522 "Generate a vertical tree."
523 (let* ((dummy (stringp (car thread)))
525 (memq (mail-header-number (car thread)) gnus-tmp-limit)))
528 ;; We don't want this article.
529 (setq thread (cdr thread))
530 (if (not (save-excursion (beginning-of-line) (bobp)))
531 ;; Not the first article on the line, so we insert a "-".
533 (gnus-tree-indent-vertical)
534 (insert (make-string (/ gnus-tree-node-length 2) ? ))
535 (insert (caddr gnus-tree-parent-child-edges))
536 (gnus-tree-forward-line 1))
537 ;; If the level isn't zero, then we insert some indentation.
538 (unless (zerop gnus-tmp-indent)
539 (gnus-tree-forward-line (1- (* 2 level)))
540 (gnus-tree-indent-vertical)
542 (insert (cadr gnus-tree-parent-child-edges))
544 ;; Draw "-" lines leftwards.
547 (= (following-char) ? ))
549 (insert (car gnus-tree-parent-child-edges)))
551 (gnus-tree-forward-line 1)))
553 ;; Insert the article node.
554 (gnus-tree-indent-vertical)
555 (gnus-tree-node-insert (pop thread) gnus-tmp-sparse adopted)
556 (gnus-tree-forward-line 1))
558 ;; End of the thread, so we go to the next line.
560 (goto-char (point-min))
562 (incf gnus-tmp-indent))
563 ;; Recurse downwards in all children of this article.
565 (gnus-generate-vertical-tree
566 (pop thread) (if do (1+ level) level)
567 (or dummyp dummy) dummy)))))
569 ;;; Interface functions.
571 (defun gnus-possibly-generate-tree (article &optional force)
572 "Generate the thread tree for ARTICLE if it isn't displayed already."
573 (when (save-excursion
574 (set-buffer gnus-summary-buffer)
576 (vectorp (gnus-summary-article-header article))))
578 (let ((top (save-excursion
579 (set-buffer gnus-summary-buffer)
583 (gnus-summary-article-header article)) t))))
584 (gnus-tmp-limit gnus-newsgroup-limit)
585 (gnus-tmp-sparse gnus-newsgroup-sparse))
587 (not (eq top gnus-tree-displayed-thread)))
588 (gnus-generate-tree top)
589 (setq gnus-tree-displayed-thread top))))))
591 (defun gnus-tree-open (group)
592 (gnus-get-tree-buffer))
594 (defun gnus-tree-close (group)
595 ;(gnus-kill-buffer gnus-tree-buffer)
598 (defun gnus-highlight-selected-tree (article)
599 "Highlight the selected article in the tree."
600 (let ((buf (current-buffer))
602 (set-buffer gnus-tree-buffer)
603 (when (setq region (gnus-tree-article-region article))
604 (when (or (not gnus-selected-tree-overlay)
605 (gnus-extent-detached-p gnus-selected-tree-overlay))
606 ;; Create a new overlay.
608 (setq gnus-selected-tree-overlay (gnus-make-overlay 1 2))
609 'face gnus-selected-tree-face))
610 ;; Move the overlay to the article.
612 gnus-selected-tree-overlay (goto-char (car region)) (cdr region))
615 (let ((selected (selected-window)))
616 (when (get-buffer-window (set-buffer gnus-tree-buffer) t)
617 (select-window (get-buffer-window (set-buffer gnus-tree-buffer) t))
618 (gnus-horizontal-recenter)
619 (select-window selected))))
620 ;; If we remove this save-excursion, it updates the wrong mode lines?!?
622 (set-buffer gnus-tree-buffer)
623 (gnus-set-mode-line 'tree))
626 (defun gnus-tree-highlight-article (article face)
628 (set-buffer (gnus-get-tree-buffer))
630 (when (setq region (gnus-tree-article-region article))
631 (put-text-property (car region) (cdr region) 'face face)
633 (get-buffer-window (current-buffer) t) (cdr region))))))
635 ;;; Allow redefinition of functions.
640 ;;; gnus-salt.el ends here