Synch to Oort Gnus.
[elisp/gnus.git-] / lisp / gnus-topic.el
1 ;;; gnus-topic.el --- a folding minor mode for Gnus group buffers
2 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Ilja Weis <kult@uni-paderborn.de>
6 ;;      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 2, or (at your option)
14 ;; 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; see the file COPYING.  If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
25
26 ;;; Commentary:
27
28 ;;; Code:
29
30 (eval-when-compile (require 'cl))
31 (eval-when-compile (require 'gnus-clfns))
32
33 (require 'gnus)
34 (require 'gnus-group)
35 (require 'gnus-start)
36 (require 'gnus-util)
37
38 (defgroup gnus-topic nil
39   "Group topics."
40   :group 'gnus-group)
41
42 (defvar gnus-topic-mode nil
43   "Minor mode for Gnus group buffers.")
44
45 (defcustom gnus-topic-mode-hook nil
46   "Hook run in topic mode buffers."
47   :type 'hook
48   :group 'gnus-topic)
49
50 (when (featurep 'xemacs)
51   (add-hook 'gnus-topic-mode-hook 'gnus-xmas-topic-menu-add))
52
53 (defcustom gnus-topic-line-format "%i[ %(%{%n%}%) -- %A ]%v\n"
54   "Format of topic lines.
55 It works along the same lines as a normal formatting string,
56 with some simple extensions.
57
58 %i  Indentation based on topic level.
59 %n  Topic name.
60 %v  Nothing if the topic is visible, \"...\" otherwise.
61 %g  Number of groups in the topic.
62 %a  Number of unread articles in the groups in the topic.
63 %A  Number of unread articles in the groups in the topic and its subtopics.
64
65 General format specifiers can also be used.
66 See Info node `(gnus)Formatting Variables'."
67   :link '(custom-manual "(gnus)Formatting Variables")
68   :type 'string
69   :group 'gnus-topic)
70
71 (defcustom gnus-topic-indent-level 2
72   "*How much each subtopic should be indented."
73   :type 'integer
74   :group 'gnus-topic)
75
76 (defcustom gnus-topic-display-empty-topics t
77   "*If non-nil, display the topic lines even of topics that have no unread articles."
78   :type 'boolean
79   :group 'gnus-topic)
80
81 ;; Internal variables.
82
83 (defvar gnus-topic-active-topology nil)
84 (defvar gnus-topic-active-alist nil)
85 (defvar gnus-topic-unreads nil)
86
87 (defvar gnus-topology-checked-p nil
88   "Whether the topology has been checked in this session.")
89
90 (defvar gnus-topic-killed-topics nil)
91 (defvar gnus-topic-inhibit-change-level nil)
92
93 (defconst gnus-topic-line-format-alist
94   `((?n name ?s)
95     (?v visible ?s)
96     (?i indentation ?s)
97     (?g number-of-groups ?d)
98     (?a (gnus-topic-articles-in-topic entries) ?d)
99     (?A total-number-of-articles ?d)
100     (?l level ?d)))
101
102 (defvar gnus-topic-line-format-spec nil)
103
104 ;;; Utility functions
105
106 (defun gnus-group-topic-name ()
107   "The name of the topic on the current line."
108   (let ((topic (get-text-property (gnus-point-at-bol) 'gnus-topic)))
109     (and topic (symbol-name topic))))
110
111 (defun gnus-group-topic-level ()
112   "The level of the topic on the current line."
113   (get-text-property (gnus-point-at-bol) 'gnus-topic-level))
114
115 (defun gnus-group-topic-unread ()
116   "The number of unread articles in topic on the current line."
117   (get-text-property (gnus-point-at-bol) 'gnus-topic-unread))
118
119 (defun gnus-topic-unread (topic)
120   "Return the number of unread articles in TOPIC."
121   (or (cdr (assoc topic gnus-topic-unreads))
122       0))
123
124 (defun gnus-group-topic-p ()
125   "Return non-nil if the current line is a topic."
126   (gnus-group-topic-name))
127
128 (defun gnus-topic-visible-p ()
129   "Return non-nil if the current topic is visible."
130   (get-text-property (gnus-point-at-bol) 'gnus-topic-visible))
131
132 (defun gnus-topic-articles-in-topic (entries)
133   (let ((total 0)
134         number)
135     (while entries
136       (when (numberp (setq number (car (pop entries))))
137         (incf total number)))
138     total))
139
140 (defun gnus-group-topic (group)
141   "Return the topic GROUP is a member of."
142   (let ((alist gnus-topic-alist)
143         out)
144     (while alist
145       (when (member group (cdar alist))
146         (setq out (caar alist)
147               alist nil))
148       (setq alist (cdr alist)))
149     out))
150
151 (defun gnus-group-parent-topic (group)
152   "Return the topic GROUP is member of by looking at the group buffer."
153   (save-excursion
154     (set-buffer gnus-group-buffer)
155     (if (gnus-group-goto-group group)
156         (gnus-current-topic)
157       (gnus-group-topic group))))
158
159 (defun gnus-topic-goto-topic (topic)
160   (when topic
161     (gnus-goto-char (text-property-any (point-min) (point-max)
162                                        'gnus-topic (intern topic)))))
163
164 (defun gnus-topic-jump-to-topic (topic)
165   "Go to TOPIC."
166   (interactive
167    (list (completing-read "Go to topic: "
168                           (mapcar 'list (gnus-topic-list))
169                           nil t)))
170   (dolist (topic (gnus-current-topics topic))
171     (gnus-topic-goto-topic topic)
172     (gnus-topic-fold t))
173   (gnus-topic-goto-topic topic))
174
175 (defun gnus-current-topic ()
176   "Return the name of the current topic."
177   (let ((result
178          (or (get-text-property (point) 'gnus-topic)
179              (save-excursion
180                (and (gnus-goto-char (previous-single-property-change
181                                      (point) 'gnus-topic))
182                     (get-text-property (max (1- (point)) (point-min))
183                                        'gnus-topic))))))
184     (when result
185       (symbol-name result))))
186
187 (defun gnus-current-topics (&optional topic)
188   "Return a list of all current topics, lowest in hierarchy first.
189 If TOPIC, start with that topic."
190   (let ((topic (or topic (gnus-current-topic)))
191         topics)
192     (while topic
193       (push topic topics)
194       (setq topic (gnus-topic-parent-topic topic)))
195     (nreverse topics)))
196
197 (defun gnus-group-active-topic-p ()
198   "Say whether the current topic comes from the active topics."
199   (save-excursion
200     (beginning-of-line)
201     (get-text-property (point) 'gnus-active)))
202
203 (defun gnus-topic-find-groups (topic &optional level all lowest recursive)
204   "Return entries for all visible groups in TOPIC.
205 If RECURSIVE is t, return groups in its subtopics too."
206   (let ((groups (cdr (assoc topic gnus-topic-alist)))
207         info clevel unread group params visible-groups entry active)
208     (setq lowest (or lowest 1))
209     (setq level (or level gnus-level-unsubscribed))
210     ;; We go through the newsrc to look for matches.
211     (while groups
212       (when (setq group (pop groups))
213         (setq entry (gnus-gethash group gnus-newsrc-hashtb)
214               info (nth 2 entry)
215               params (gnus-info-params info)
216               active (gnus-active group)
217               unread (or (car entry)
218                          (and (not (equal group "dummy.group"))
219                               active
220                               (- (1+ (cdr active)) (car active))))
221               clevel (or (gnus-info-level info)
222                          (if (member group gnus-zombie-list)
223                              gnus-level-zombie gnus-level-killed))))
224       (and
225        info                             ; nil means that the group is dead.
226        (<= clevel level)
227        (>= clevel lowest)               ; Is inside the level we want.
228        (or all
229            (if (or (eq unread t)
230                    (eq unread nil))
231                gnus-group-list-inactive-groups
232              (> unread 0))
233            (and gnus-list-groups-with-ticked-articles
234                 (cdr (assq 'tick (gnus-info-marks info))))
235            ;; Has right readedness.
236            ;; Check for permanent visibility.
237            (and gnus-permanently-visible-groups
238                 (string-match gnus-permanently-visible-groups group))
239            (memq 'visible params)
240            (cdr (assq 'visible params)))
241        ;; Add this group to the list of visible groups.
242        (push (or entry group) visible-groups)))
243     (setq visible-groups (nreverse visible-groups))
244     (when recursive
245       (if (eq recursive t)
246           (setq recursive (cdr (gnus-topic-find-topology topic))))
247       (mapcar (lambda (topic-topology)
248                 (setq visible-groups
249                       (nconc visible-groups
250                              (gnus-topic-find-groups
251                               (caar topic-topology)
252                               level all lowest topic-topology))))
253               (cdr recursive)))
254     visible-groups))
255
256 (defun gnus-topic-goto-previous-topic (n)
257   "Go to the N'th previous topic."
258   (interactive "p")
259   (gnus-topic-goto-next-topic (- n)))
260
261 (defun gnus-topic-goto-next-topic (n)
262   "Go to the N'th next topic."
263   (interactive "p")
264   (let ((backward (< n 0))
265         (n (abs n))
266         (topic (gnus-current-topic)))
267     (while (and (> n 0)
268                 (setq topic
269                       (if backward
270                           (gnus-topic-previous-topic topic)
271                         (gnus-topic-next-topic topic))))
272       (gnus-topic-goto-topic topic)
273       (setq n (1- n)))
274     (when (/= 0 n)
275       (gnus-message 7 "No more topics"))
276     n))
277
278 (defun gnus-topic-previous-topic (topic)
279   "Return the previous topic on the same level as TOPIC."
280   (let ((top (cddr (gnus-topic-find-topology
281                     (gnus-topic-parent-topic topic)))))
282     (unless (equal topic (caaar top))
283       (while (and top (not (equal (caaadr top) topic)))
284         (setq top (cdr top)))
285       (caaar top))))
286
287 (defun gnus-topic-parent-topic (topic &optional topology)
288   "Return the parent of TOPIC."
289   (unless topology
290     (setq topology gnus-topic-topology))
291   (let ((parent (car (pop topology)))
292         result found)
293     (while (and topology
294                 (not (setq found (equal (caaar topology) topic)))
295                 (not (setq result (gnus-topic-parent-topic
296                                    topic (car topology)))))
297       (setq topology (cdr topology)))
298     (or result (and found parent))))
299
300 (defun gnus-topic-next-topic (topic &optional previous)
301   "Return the next sibling of TOPIC."
302   (let ((parentt (cddr (gnus-topic-find-topology
303                         (gnus-topic-parent-topic topic))))
304         prev)
305     (while (and parentt
306                 (not (equal (caaar parentt) topic)))
307       (setq prev (caaar parentt)
308             parentt (cdr parentt)))
309     (if previous
310         prev
311       (caaadr parentt))))
312
313 (defun gnus-topic-forward-topic (num)
314   "Go to the next topic on the same level as the current one."
315   (let* ((topic (gnus-current-topic))
316          (way (if (< num 0) 'gnus-topic-previous-topic
317                 'gnus-topic-next-topic))
318          (num (abs num)))
319     (while (and (not (zerop num))
320                 (setq topic (funcall way topic)))
321       (when (gnus-topic-goto-topic topic)
322         (decf num)))
323     (unless (zerop num)
324       (goto-char (point-max)))
325     num))
326
327 (defun gnus-topic-find-topology (topic &optional topology level remove)
328   "Return the topology of TOPIC."
329   (unless topology
330     (setq topology gnus-topic-topology)
331     (setq level 0))
332   (let ((top topology)
333         result)
334     (if (equal (caar topology) topic)
335         (progn
336           (when remove
337             (delq topology remove))
338           (cons level topology))
339       (setq topology (cdr topology))
340       (while (and topology
341                   (not (setq result (gnus-topic-find-topology
342                                      topic (car topology) (1+ level)
343                                      (and remove top)))))
344         (setq topology (cdr topology)))
345       result)))
346
347 (defvar gnus-tmp-topics nil)
348 (defun gnus-topic-list (&optional topology)
349   "Return a list of all topics in the topology."
350   (unless topology
351     (setq topology gnus-topic-topology
352           gnus-tmp-topics nil))
353   (push (caar topology) gnus-tmp-topics)
354   (mapcar 'gnus-topic-list (cdr topology))
355   gnus-tmp-topics)
356
357 ;;; Topic parameter jazz
358
359 (defun gnus-topic-parameters (topic)
360   "Return the parameters for TOPIC."
361   (let ((top (gnus-topic-find-topology topic)))
362     (when top
363       (nth 3 (cadr top)))))
364
365 (defun gnus-topic-set-parameters (topic parameters)
366   "Set the topic parameters of TOPIC to PARAMETERS."
367   (let ((top (gnus-topic-find-topology topic)))
368     (unless top
369       (error "No such topic: %s" topic))
370     ;; We may have to extend if there is no parameters here
371     ;; to begin with.
372     (unless (nthcdr 2 (cadr top))
373       (nconc (cadr top) (list nil)))
374     (unless (nthcdr 3 (cadr top))
375       (nconc (cadr top) (list nil)))
376     (setcar (nthcdr 3 (cadr top)) parameters)
377     (gnus-dribble-enter
378      (format "(gnus-topic-set-parameters %S '%S)" topic parameters))))
379
380 (defun gnus-group-topic-parameters (group)
381   "Compute the group parameters for GROUP taking into account inheritance from topics."
382   (let ((params-list (copy-sequence (gnus-group-get-parameter group))))
383     (save-excursion
384       (nconc params-list
385              (gnus-topic-hierarchical-parameters
386               ;; First we try to go to the group within the group
387               ;; buffer and find the topic for the group that way.
388               ;; This hopefully copes well with groups that are in
389               ;; more than one topic.  Failing that (i.e. when the
390               ;; group isn't visible in the group buffer) we find a
391               ;; topic for the group via gnus-group-topic.
392               (or (and (gnus-group-goto-group group)
393                        (gnus-current-topic))
394                   (gnus-group-topic group)))))))
395
396 (defun gnus-topic-hierarchical-parameters (topic)
397   "Return a topic list computed for TOPIC."
398   (let ((topics (gnus-current-topics topic))
399         params-list param out params)
400     (while topics
401       (push (gnus-topic-parameters (pop topics)) params-list))
402     ;; We probably have lots of nil elements here, so
403     ;; we remove them.  Probably faster than doing this "properly".
404     (setq params-list (delq nil params-list))
405     ;; Now we have all the parameters, so we go through them
406     ;; and do inheritance in the obvious way.
407     (while (setq params (pop params-list))
408       (while (setq param (pop params))
409         (when (atom param)
410           (setq param (cons param t)))
411         ;; Override any old versions of this param.
412         (gnus-pull (car param) out)
413         (push param out)))
414     ;; Return the resulting parameter list.
415     out))
416
417 ;;; General utility functions
418
419 (defun gnus-topic-enter-dribble ()
420   (gnus-dribble-enter
421    (format "(setq gnus-topic-topology '%S)" gnus-topic-topology)))
422
423 ;;; Generating group buffers
424
425 (defun gnus-group-prepare-topics (level &optional predicate lowest
426                                         regexp list-topic topic-level)
427   "List all newsgroups with unread articles of level LEVEL or lower.
428 Use the `gnus-group-topics' to sort the groups.
429 If PREDICTE is a function, list groups that the function returns non-nil;
430 if it is t, list groups that have no unread articles.
431 If LOWEST is non-nil, list all newsgroups of level LOWEST or higher."
432   (set-buffer gnus-group-buffer)
433   (let ((buffer-read-only nil)
434         (lowest (or lowest 1))
435         (not-in-list
436          (and gnus-group-listed-groups
437               (copy-sequence gnus-group-listed-groups))))
438
439     (when (or (not gnus-topic-alist)
440               (not gnus-topology-checked-p))
441       (gnus-topic-check-topology))
442
443     (unless list-topic
444       (erase-buffer))
445
446     ;; List dead groups?
447     (when (or gnus-group-listed-groups
448               (and (>= level gnus-level-zombie)
449                    (<= lowest gnus-level-zombie)))
450       (gnus-group-prepare-flat-list-dead
451        (setq gnus-zombie-list (sort gnus-zombie-list 'string<))
452        gnus-level-zombie ?Z
453        regexp))
454
455     (when (or gnus-group-listed-groups
456               (and (>= level gnus-level-killed)
457                    (<= lowest gnus-level-killed)))
458       (gnus-group-prepare-flat-list-dead
459        (setq gnus-killed-list (sort gnus-killed-list 'string<))
460        gnus-level-killed ?K regexp)
461       (when not-in-list
462         (unless gnus-killed-hashtb
463           (gnus-make-hashtable-from-killed))
464         (gnus-group-prepare-flat-list-dead
465          (gnus-remove-if (lambda (group)
466                            (or (gnus-gethash group gnus-newsrc-hashtb)
467                                (gnus-gethash group gnus-killed-hashtb)))
468                          not-in-list)
469          gnus-level-killed ?K regexp)))
470
471     ;; Use topics.
472     (prog1
473         (when (or (< lowest gnus-level-zombie)
474                   gnus-group-listed-groups)
475           (if list-topic
476               (let ((top (gnus-topic-find-topology list-topic)))
477                 (gnus-topic-prepare-topic (cdr top) (car top)
478                                           (or topic-level level) predicate
479                                           nil lowest regexp))
480             (gnus-topic-prepare-topic gnus-topic-topology 0
481                                       (or topic-level level) predicate
482                                       nil lowest regexp)))
483       (gnus-group-set-mode-line)
484       (setq gnus-group-list-mode (cons level predicate))
485       (gnus-run-hooks 'gnus-group-prepare-hook))))
486
487 (defun gnus-topic-prepare-topic (topicl level &optional list-level
488                                         predicate silent
489                                         lowest regexp)
490   "Insert TOPIC into the group buffer.
491 If SILENT, don't insert anything.  Return the number of unread
492 articles in the topic and its subtopics."
493   (let* ((type (pop topicl))
494          (entries (gnus-topic-find-groups
495                    (car type)
496                    (if gnus-group-listed-groups
497                        gnus-level-killed
498                      list-level)
499                    (or predicate gnus-group-listed-groups
500                        (cdr (assq 'visible
501                                   (gnus-topic-hierarchical-parameters
502                                    (car type)))))
503                    (if gnus-group-listed-groups 0 lowest)))
504          (visiblep (and (eq (nth 1 type) 'visible) (not silent)))
505          (gnus-group-indentation
506           (make-string (* gnus-topic-indent-level level) ? ))
507          (beg (progn (beginning-of-line) (point)))
508          (topicl (reverse topicl))
509          (all-entries entries)
510          (point-max (point-max))
511          (unread 0)
512          (topic (car type))
513          info entry end active tick)
514     ;; Insert any sub-topics.
515     (while topicl
516       (incf unread
517             (gnus-topic-prepare-topic
518              (pop topicl) (1+ level) list-level predicate
519              (not visiblep) lowest regexp)))
520     (setq end (point))
521     (goto-char beg)
522     ;; Insert all the groups that belong in this topic.
523     (while (setq entry (pop entries))
524       (when (if (stringp entry)
525                 (gnus-group-prepare-logic
526                  entry
527                  (and
528                   (or (not gnus-group-listed-groups)
529                       (if (< list-level gnus-level-zombie) nil
530                         (let ((entry-level
531                                (if (member entry gnus-zombie-list)
532                                    gnus-level-zombie gnus-level-killed)))
533                           (and (<= entry-level list-level)
534                                (>= entry-level lowest)))))
535                   (cond
536                    ((stringp regexp)
537                     (string-match regexp entry))
538                    ((functionp regexp)
539                     (funcall regexp entry))
540                    ((null regexp) t)
541                    (t nil))))
542               (setq info (nth 2 entry))
543               (gnus-group-prepare-logic
544                (gnus-info-group info)
545                (and (or (not gnus-group-listed-groups)
546                         (let ((entry-level (gnus-info-level info)))
547                           (and (<= entry-level list-level)
548                                (>= entry-level lowest))))
549                     (or (not (functionp predicate))
550                         (funcall predicate info))
551                     (or (not (stringp regexp))
552                         (string-match regexp (gnus-info-group info))))))
553         (when visiblep
554           (if (stringp entry)
555               ;; Dead groups.
556               (gnus-group-insert-group-line
557                entry (if (member entry gnus-zombie-list)
558                          gnus-level-zombie gnus-level-killed)
559                nil (- (1+ (cdr (setq active (gnus-active entry))))
560                       (car active))
561                nil)
562             ;; Living groups.
563             (when (setq info (nth 2 entry))
564               (gnus-group-insert-group-line
565                (gnus-info-group info)
566                (gnus-info-level info) (gnus-info-marks info)
567                (car entry) (gnus-info-method info)))))
568         (when (and (listp entry)
569                    (numberp (car entry)))
570           (incf unread (car entry)))
571         (when (listp entry)
572           (setq tick t))))
573     (goto-char beg)
574     ;; Insert the topic line.
575     (when (and (not silent)
576                (or gnus-topic-display-empty-topics ;We want empty topics
577                    (not (zerop unread)) ;Non-empty
578                    tick                 ;Ticked articles
579                    (/= point-max (point-max)))) ;Unactivated groups
580       (gnus-extent-start-open (point))
581       (gnus-topic-insert-topic-line
582        (car type) visiblep
583        (not (eq (nth 2 type) 'hidden))
584        level all-entries unread))
585     (gnus-topic-update-unreads (car type) unread)
586     (goto-char end)
587     unread))
588
589 (defun gnus-topic-remove-topic (&optional insert total-remove hide in-level)
590   "Remove the current topic."
591   (let ((topic (gnus-group-topic-name))
592         (level (gnus-group-topic-level))
593         (beg (progn (beginning-of-line) (point)))
594         buffer-read-only)
595     (when topic
596       (while (and (zerop (forward-line 1))
597                   (> (or (gnus-group-topic-level) (1+ level)) level)))
598       (delete-region beg (point))
599       ;; Do the change in this rather odd manner because it has been
600       ;; reported that some topics share parts of some lists, for some
601       ;; reason.  I have been unable to determine why this is the
602       ;; case, but this hack seems to take care of things.
603       (let ((data (cadr (gnus-topic-find-topology topic))))
604         (setcdr data
605                 (list (if insert 'visible 'invisible)
606                       (caddr data)
607                       (cadddr data))))
608       (if total-remove
609           (setq gnus-topic-alist
610                 (delq (assoc topic gnus-topic-alist) gnus-topic-alist))
611         (gnus-topic-insert-topic topic in-level)))))
612
613 (defun gnus-topic-insert-topic (topic &optional level)
614   "Insert TOPIC."
615   (gnus-group-prepare-topics
616    (car gnus-group-list-mode) (cdr gnus-group-list-mode)
617    nil nil topic level))
618
619 (defun gnus-topic-fold (&optional insert topic)
620   "Remove/insert the current topic."
621   (let ((topic (or topic (gnus-group-topic-name))))
622     (when topic
623       (save-excursion
624         (if (not (gnus-group-active-topic-p))
625             (gnus-topic-remove-topic
626              (or insert (not (gnus-topic-visible-p))))
627           (let ((gnus-topic-topology gnus-topic-active-topology)
628                 (gnus-topic-alist gnus-topic-active-alist)
629                 (gnus-group-list-mode (cons 5 t)))
630             (gnus-topic-remove-topic
631              (or insert (not (gnus-topic-visible-p))) nil nil 9)
632             (gnus-topic-enter-dribble)))))))
633
634 (defun gnus-topic-insert-topic-line (name visiblep shownp level entries
635                                           &optional unread)
636   (let* ((visible (if visiblep "" "..."))
637          (indentation (make-string (* gnus-topic-indent-level level) ? ))
638          (total-number-of-articles unread)
639          (number-of-groups (length entries))
640          (active-topic (eq gnus-topic-alist gnus-topic-active-alist))
641          gnus-tmp-header)
642     (gnus-topic-update-unreads name unread)
643     (beginning-of-line)
644     ;; Insert the text.
645     (if shownp
646         (gnus-add-text-properties
647          (point)
648          (prog1 (1+ (point))
649            (eval gnus-topic-line-format-spec))
650          (list 'gnus-topic (intern name)
651                'gnus-topic-level level
652                'gnus-topic-unread unread
653                'gnus-active active-topic
654                'gnus-topic-visible visiblep)))))
655
656 (defun gnus-topic-update-unreads (topic unreads)
657   (setq gnus-topic-unreads (delq (assoc topic gnus-topic-unreads)
658                                  gnus-topic-unreads))
659   (push (cons topic unreads) gnus-topic-unreads))
660
661 (defun gnus-topic-update-topics-containing-group (group)
662   "Update all topics that have GROUP as a member."
663   (when (and (eq major-mode 'gnus-group-mode)
664              gnus-topic-mode)
665     (save-excursion
666       (let ((alist gnus-topic-alist))
667         ;; This is probably not entirely correct.  If a topic
668         ;; isn't shown, then it's not updated.  But the updating
669         ;; should be performed in any case, since the topic's
670         ;; parent should be updated.  Pfft.
671         (while alist
672           (when (and (member group (cdar alist))
673                      (gnus-topic-goto-topic (caar alist)))
674             (gnus-topic-update-topic-line (caar alist)))
675           (pop alist))))))
676
677 (defun gnus-topic-update-topic ()
678   "Update all parent topics to the current group."
679   (when (and (eq major-mode 'gnus-group-mode)
680              gnus-topic-mode)
681     (let ((group (gnus-group-group-name))
682           (m (point-marker))
683           (buffer-read-only nil))
684       (when (and group
685                  (gnus-get-info group)
686                  (gnus-topic-goto-topic (gnus-current-topic)))
687         (gnus-topic-update-topic-line (gnus-group-topic-name))
688         (goto-char m)
689         (set-marker m nil)
690         (gnus-group-position-point)))))
691
692 (defun gnus-topic-goto-missing-group (group)
693   "Place point where GROUP is supposed to be inserted."
694   (let* ((topic (gnus-group-topic group))
695          (groups (cdr (assoc topic gnus-topic-alist)))
696          (g (cdr (member group groups)))
697          (unfound t)
698          entry)
699     ;; Try to jump to a visible group.
700     (while (and g
701                 (not (gnus-group-goto-group (car g) t)))
702       (pop g))
703     ;; It wasn't visible, so we try to see where to insert it.
704     (when (not g)
705       (setq g (cdr (member group (reverse groups))))
706       (while (and g unfound)
707         (when (gnus-group-goto-group (pop g) t)
708           (forward-line 1)
709           (setq unfound nil)))
710       (when (and unfound
711                  topic
712                  (not (gnus-topic-goto-missing-topic topic)))
713         (gnus-topic-display-missing-topic topic)))))
714
715 (defun gnus-topic-display-missing-topic (topic)
716   "Insert topic lines recursively for missing topics."
717   (let ((parent (gnus-topic-find-topology
718                  (gnus-topic-parent-topic topic))))
719     (when (and parent
720                (not (gnus-topic-goto-missing-topic (caadr parent))))
721       (gnus-topic-display-missing-topic (caadr parent))))
722   (gnus-topic-goto-missing-topic topic)
723   (let* ((top (gnus-topic-find-topology topic))
724          (children (cddr top))
725          (type (cadr top))
726          (unread 0)
727          (entries (gnus-topic-find-groups
728                    (car type) (car gnus-group-list-mode)
729                    (cdr gnus-group-list-mode)))
730         entry)
731     (while children
732       (incf unread (gnus-topic-unread (caar (pop children)))))
733     (while (setq entry (pop entries))
734       (when (numberp (car entry))
735         (incf unread (car entry))))
736     (gnus-topic-insert-topic-line
737      topic t t (car (gnus-topic-find-topology topic)) nil unread)))
738
739 (defun gnus-topic-goto-missing-topic (topic)
740   (if (gnus-topic-goto-topic topic)
741       (forward-line 1)
742     ;; Topic not displayed.
743     (let* ((top (gnus-topic-find-topology
744                  (gnus-topic-parent-topic topic)))
745            (tp (reverse (cddr top))))
746       (if (not top)
747           (gnus-topic-insert-topic-line
748            topic t t (car (gnus-topic-find-topology topic)) nil 0)
749         (while (not (equal (caaar tp) topic))
750           (setq tp (cdr tp)))
751         (pop tp)
752         (while (and tp
753                     (not (gnus-topic-goto-topic (caaar tp))))
754           (pop tp))
755         (if tp
756             (forward-line 1)
757           (gnus-topic-goto-missing-topic (caadr top)))))
758     nil))
759
760 (defun gnus-topic-update-topic-line (topic-name &optional reads)
761   (let* ((top (gnus-topic-find-topology topic-name))
762          (type (cadr top))
763          (children (cddr top))
764          (entries (gnus-topic-find-groups
765                    (car type) (car gnus-group-list-mode)
766                    (cdr gnus-group-list-mode)))
767          (parent (gnus-topic-parent-topic topic-name))
768          (all-entries entries)
769          (unread 0)
770          old-unread entry new-unread)
771     (when (gnus-topic-goto-topic (car type))
772       ;; Tally all the groups that belong in this topic.
773       (if reads
774           (setq unread (- (gnus-group-topic-unread) reads))
775         (while children
776           (incf unread (gnus-topic-unread (caar (pop children)))))
777         (while (setq entry (pop entries))
778           (when (numberp (car entry))
779             (incf unread (car entry)))))
780       (setq old-unread (gnus-group-topic-unread))
781       ;; Insert the topic line.
782       (gnus-topic-insert-topic-line
783        (car type) (gnus-topic-visible-p)
784        (not (eq (nth 2 type) 'hidden))
785        (gnus-group-topic-level) all-entries unread)
786       (gnus-delete-line)
787       (forward-line -1)
788       (setq new-unread (gnus-group-topic-unread)))
789     (when parent
790       (forward-line -1)
791       (gnus-topic-update-topic-line
792        parent
793        (- (or old-unread 0) (or new-unread 0))))
794     unread))
795
796 (defun gnus-topic-group-indentation ()
797   (make-string
798    (* gnus-topic-indent-level
799       (or (save-excursion
800             (forward-line -1)
801             (gnus-topic-goto-topic (gnus-current-topic))
802             (gnus-group-topic-level))
803           0))
804    ? ))
805
806 ;;; Initialization
807
808 (gnus-add-shutdown 'gnus-topic-close 'gnus)
809
810 (defun gnus-topic-close ()
811   (setq gnus-topic-active-topology nil
812         gnus-topic-active-alist nil
813         gnus-topic-killed-topics nil
814         gnus-topology-checked-p nil))
815
816 (defun gnus-topic-check-topology ()
817   ;; The first time we set the topology to whatever we have
818   ;; gotten here, which can be rather random.
819   (unless gnus-topic-alist
820     (gnus-topic-init-alist))
821
822   (setq gnus-topology-checked-p t)
823   ;; Go through the topic alist and make sure that all topics
824   ;; are in the topic topology.
825   (let ((topics (gnus-topic-list))
826         (alist gnus-topic-alist)
827         changed)
828     (while alist
829       (unless (member (caar alist) topics)
830         (nconc gnus-topic-topology
831                (list (list (list (caar alist) 'visible))))
832         (setq changed t))
833       (setq alist (cdr alist)))
834     (when changed
835       (gnus-topic-enter-dribble))
836     ;; Conversely, go through the topology and make sure that all
837     ;; topologies have alists.
838     (while topics
839       (unless (assoc (car topics) gnus-topic-alist)
840         (push (list (car topics)) gnus-topic-alist))
841       (pop topics)))
842   ;; Go through all living groups and make sure that
843   ;; they belong to some topic.
844   (let* ((tgroups (apply 'append (mapcar (lambda (entry) (cdr entry))
845                                          gnus-topic-alist)))
846          (entry (last (assoc (caar gnus-topic-topology) gnus-topic-alist)))
847          (newsrc (cdr gnus-newsrc-alist))
848          group)
849     (while newsrc
850       (unless (member (setq group (gnus-info-group (pop newsrc))) tgroups)
851         (setcdr entry (list group))
852         (setq entry (cdr entry)))))
853   ;; Go through all topics and make sure they contain only living groups.
854   (let ((alist gnus-topic-alist)
855         topic)
856     (while (setq topic (pop alist))
857       (while (cdr topic)
858         (if (and (cadr topic)
859                  (gnus-gethash (cadr topic) gnus-newsrc-hashtb))
860             (setq topic (cdr topic))
861           (setcdr topic (cddr topic)))))))
862
863 (defun gnus-topic-init-alist ()
864   "Initialize the topic structures."
865   (setq gnus-topic-topology
866         (cons (list "Gnus" 'visible)
867               (mapcar (lambda (topic)
868                         (list (list (car topic) 'visible)))
869                       '(("misc")))))
870   (setq gnus-topic-alist
871         (list (cons "misc"
872                     (mapcar (lambda (info) (gnus-info-group info))
873                             (cdr gnus-newsrc-alist)))
874               (list "Gnus")))
875   (gnus-topic-enter-dribble))
876
877 ;;; Maintenance
878
879 (defun gnus-topic-clean-alist ()
880   "Remove bogus groups from the topic alist."
881   (let ((topic-alist gnus-topic-alist)
882         result topic)
883     (unless gnus-killed-hashtb
884       (gnus-make-hashtable-from-killed))
885     (while (setq topic (pop topic-alist))
886       (let ((topic-name (pop topic))
887             group filtered-topic)
888         (while (setq group (pop topic))
889           (when (and (or (gnus-gethash group gnus-active-hashtb)
890                          (gnus-info-method (gnus-get-info group)))
891                      (not (gnus-gethash group gnus-killed-hashtb)))
892             (push group filtered-topic)))
893         (push (cons topic-name (nreverse filtered-topic)) result)))
894     (setq gnus-topic-alist (nreverse result))))
895
896 (defun gnus-topic-change-level (group level oldlevel &optional previous)
897   "Run when changing levels to enter/remove groups from topics."
898   (save-excursion
899     (set-buffer gnus-group-buffer)
900     (let ((buffer-read-only nil))
901       (unless gnus-topic-inhibit-change-level
902         (gnus-group-goto-group (or (car (nth 2 previous)) group))
903         (when (and gnus-topic-mode
904                    gnus-topic-alist
905                    (not gnus-topic-inhibit-change-level))
906           ;; Remove the group from the topics.
907           (if (and (< oldlevel gnus-level-zombie)
908                    (>= level gnus-level-zombie))
909               (let ((alist gnus-topic-alist))
910                 (while (gnus-group-goto-group group)
911                   (gnus-delete-line))
912                 (while alist
913                   (when (member group (car alist))
914                     (setcdr (car alist) (delete group (cdar alist))))
915                   (pop alist)))
916             ;; If the group is subscribed we enter it into the topics.
917             (when (and (< level gnus-level-zombie)
918                        (>= oldlevel gnus-level-zombie))
919               (let* ((prev (gnus-group-group-name))
920                      (gnus-topic-inhibit-change-level t)
921                      (gnus-group-indentation
922                       (make-string
923                        (* gnus-topic-indent-level
924                           (or (save-excursion
925                                 (gnus-topic-goto-topic (gnus-current-topic))
926                                 (gnus-group-topic-level))
927                               0))
928                        ? ))
929                      (yanked (list group))
930                      alist talist end)
931                 ;; Then we enter the yanked groups into the topics they belong
932                 ;; to.
933                 (when (setq alist (assoc (save-excursion
934                                            (forward-line -1)
935                                            (or
936                                             (gnus-current-topic)
937                                             (caar gnus-topic-topology)))
938                                          gnus-topic-alist))
939                   (setq talist alist)
940                   (when (stringp yanked)
941                     (setq yanked (list yanked)))
942                   (if (not prev)
943                       (nconc alist yanked)
944                     (if (not (cdr alist))
945                         (setcdr alist (nconc yanked (cdr alist)))
946                       (while (and (not end) (cdr alist))
947                         (when (equal (cadr alist) prev)
948                           (setcdr alist (nconc yanked (cdr alist)))
949                           (setq end t))
950                         (setq alist (cdr alist)))
951                       (unless end
952                         (nconc talist yanked))))))
953               (gnus-topic-update-topic))))))))
954
955 (defun gnus-topic-goto-next-group (group props)
956   "Go to group or the next group after group."
957   (if (not group)
958       (if (not (memq 'gnus-topic props))
959           (goto-char (point-max))
960         (gnus-topic-goto-topic (symbol-name (cadr (memq 'gnus-topic props)))))
961     (if (gnus-group-goto-group group)
962         t
963       ;; The group is no longer visible.
964       (let* ((list (assoc (gnus-group-topic group) gnus-topic-alist))
965              (after (cdr (member group (cdr list)))))
966         ;; First try to put point on a group after the current one.
967         (while (and after
968                     (not (gnus-group-goto-group (car after))))
969           (setq after (cdr after)))
970         ;; Then try to put point on a group before point.
971         (unless after
972           (setq after (cdr (member group (reverse (cdr list)))))
973           (while (and after
974                       (not (gnus-group-goto-group (car after))))
975             (setq after (cdr after))))
976         ;; Finally, just put point on the topic.
977         (if (not (car list))
978             (goto-char (point-min))
979           (unless after
980             (gnus-topic-goto-topic (car list))
981             (setq after nil)))
982         t))))
983
984 ;;; Topic-active functions
985
986 (defun gnus-topic-grok-active (&optional force)
987   "Parse all active groups and create topic structures for them."
988   ;; First we make sure that we have really read the active file.
989   (when (or force
990             (not gnus-topic-active-alist))
991     (let (groups)
992       ;; Get a list of all groups available.
993       (mapatoms (lambda (g) (when (symbol-value g)
994                               (push (symbol-name g) groups)))
995                 gnus-active-hashtb)
996       (setq groups (sort groups 'string<))
997       ;; Init the variables.
998       (setq gnus-topic-active-topology (list (list "" 'visible)))
999       (setq gnus-topic-active-alist nil)
1000       ;; Descend the top-level hierarchy.
1001       (gnus-topic-grok-active-1 gnus-topic-active-topology groups)
1002       ;; Set the top-level topic names to something nice.
1003       (setcar (car gnus-topic-active-topology) "Gnus active")
1004       (setcar (car gnus-topic-active-alist) "Gnus active"))))
1005
1006 (defun gnus-topic-grok-active-1 (topology groups)
1007   (let* ((name (caar topology))
1008          (prefix (concat "^" (regexp-quote name)))
1009          tgroups ntopology group)
1010     (while (and groups
1011                 (string-match prefix (setq group (car groups))))
1012       (if (not (string-match "\\." group (match-end 0)))
1013           ;; There are no further hierarchies here, so we just
1014           ;; enter this group into the list belonging to this
1015           ;; topic.
1016           (push (pop groups) tgroups)
1017         ;; New sub-hierarchy, so we add it to the topology.
1018         (nconc topology (list (setq ntopology
1019                                     (list (list (substring
1020                                                  group 0 (match-end 0))
1021                                                 'invisible)))))
1022         ;; Descend the hierarchy.
1023         (setq groups (gnus-topic-grok-active-1 ntopology groups))))
1024     ;; We remove the trailing "." from the topic name.
1025     (setq name
1026           (if (string-match "\\.$" name)
1027               (substring name 0 (match-beginning 0))
1028             name))
1029     ;; Add this topic and its groups to the topic alist.
1030     (push (cons name (nreverse tgroups)) gnus-topic-active-alist)
1031     (setcar (car topology) name)
1032     ;; We return the rest of the groups that didn't belong
1033     ;; to this topic.
1034     groups))
1035
1036 ;;; Topic mode, commands and keymap.
1037
1038 (defvar gnus-topic-mode-map nil)
1039 (defvar gnus-group-topic-map nil)
1040
1041 (unless gnus-topic-mode-map
1042   (setq gnus-topic-mode-map (make-sparse-keymap))
1043
1044   ;; Override certain group mode keys.
1045   (gnus-define-keys gnus-topic-mode-map
1046     "=" gnus-topic-select-group
1047     "\r" gnus-topic-select-group
1048     " " gnus-topic-read-group
1049     "\C-c\C-x" gnus-topic-expire-articles
1050     "c" gnus-topic-catchup-articles
1051     "\C-k" gnus-topic-kill-group
1052     "\C-y" gnus-topic-yank-group
1053     "\M-g" gnus-topic-get-new-news-this-topic
1054     "AT" gnus-topic-list-active
1055     "Gp" gnus-topic-edit-parameters
1056     "#" gnus-topic-mark-topic
1057     "\M-#" gnus-topic-unmark-topic
1058     [tab] gnus-topic-indent
1059     [(meta tab)] gnus-topic-unindent
1060     "\C-i" gnus-topic-indent
1061     "\M-\C-i" gnus-topic-unindent
1062     gnus-mouse-2 gnus-mouse-pick-topic)
1063
1064   ;; Define a new submap.
1065   (gnus-define-keys (gnus-group-topic-map "T" gnus-topic-mode-map)
1066     "#" gnus-topic-mark-topic
1067     "\M-#" gnus-topic-unmark-topic
1068     "n" gnus-topic-create-topic
1069     "m" gnus-topic-move-group
1070     "D" gnus-topic-remove-group
1071     "c" gnus-topic-copy-group
1072     "h" gnus-topic-hide-topic
1073     "s" gnus-topic-show-topic
1074     "j" gnus-topic-jump-to-topic
1075     "M" gnus-topic-move-matching
1076     "C" gnus-topic-copy-matching
1077     "\M-p" gnus-topic-goto-previous-topic
1078     "\M-n" gnus-topic-goto-next-topic
1079     "\C-i" gnus-topic-indent
1080     [tab] gnus-topic-indent
1081     "r" gnus-topic-rename
1082     "\177" gnus-topic-delete
1083     [delete] gnus-topic-delete
1084     "H" gnus-topic-toggle-display-empty-topics)
1085
1086   (gnus-define-keys (gnus-topic-sort-map "S" gnus-group-topic-map)
1087     "s" gnus-topic-sort-groups
1088     "a" gnus-topic-sort-groups-by-alphabet
1089     "u" gnus-topic-sort-groups-by-unread
1090     "l" gnus-topic-sort-groups-by-level
1091     "e" gnus-topic-sort-groups-by-server
1092     "v" gnus-topic-sort-groups-by-score
1093     "r" gnus-topic-sort-groups-by-rank
1094     "m" gnus-topic-sort-groups-by-method))
1095
1096 (defun gnus-topic-make-menu-bar ()
1097   (unless (boundp 'gnus-topic-menu)
1098     (easy-menu-define
1099      gnus-topic-menu gnus-topic-mode-map ""
1100      '("Topics"
1101        ["Toggle topics" gnus-topic-mode t]
1102        ("Groups"
1103         ["Copy..." gnus-topic-copy-group t]
1104         ["Move..." gnus-topic-move-group t]
1105         ["Remove" gnus-topic-remove-group t]
1106         ["Copy matching..." gnus-topic-copy-matching t]
1107         ["Move matching" gnus-topic-move-matching t])
1108        ("Topics"
1109         ["Goto..." gnus-topic-jump-to-topic t]
1110         ["Show" gnus-topic-show-topic t]
1111         ["Hide" gnus-topic-hide-topic t]
1112         ["Delete" gnus-topic-delete t]
1113         ["Rename..." gnus-topic-rename t]
1114         ["Create..." gnus-topic-create-topic t]
1115         ["Mark" gnus-topic-mark-topic t]
1116         ["Indent" gnus-topic-indent t]
1117         ["Sort" gnus-topic-sort-topics t]
1118         ["Previous topic" gnus-topic-goto-previous-topic t]
1119         ["Next topic" gnus-topic-goto-next-topic t]
1120         ["Toggle hide empty" gnus-topic-toggle-display-empty-topics t]
1121         ["Edit parameters" gnus-topic-edit-parameters t])
1122        ["List active" gnus-topic-list-active t]))))
1123
1124 (defun gnus-topic-mode (&optional arg redisplay)
1125   "Minor mode for topicsifying Gnus group buffers."
1126   (interactive (list current-prefix-arg t))
1127   (when (eq major-mode 'gnus-group-mode)
1128     (make-local-variable 'gnus-topic-mode)
1129     (setq gnus-topic-mode
1130           (if (null arg) (not gnus-topic-mode)
1131             (> (prefix-numeric-value arg) 0)))
1132     ;; Infest Gnus with topics.
1133     (if (not gnus-topic-mode)
1134         (setq gnus-goto-missing-group-function nil)
1135       (when (gnus-visual-p 'topic-menu 'menu)
1136         (gnus-topic-make-menu-bar))
1137       (gnus-set-format 'topic t)
1138       (gnus-add-minor-mode 'gnus-topic-mode " Topic"
1139                            gnus-topic-mode-map nil (lambda (&rest junk)
1140                                                      (interactive)
1141                                                      (gnus-topic-mode nil t)))
1142       (add-hook 'gnus-group-catchup-group-hook 'gnus-topic-update-topic)
1143       (set (make-local-variable 'gnus-group-prepare-function)
1144            'gnus-group-prepare-topics)
1145       (set (make-local-variable 'gnus-group-get-parameter-function)
1146            'gnus-group-topic-parameters)
1147       (set (make-local-variable 'gnus-group-goto-next-group-function)
1148            'gnus-topic-goto-next-group)
1149       (set (make-local-variable 'gnus-group-indentation-function)
1150            'gnus-topic-group-indentation)
1151       (set (make-local-variable 'gnus-group-update-group-function)
1152            'gnus-topic-update-topics-containing-group)
1153       (set (make-local-variable 'gnus-group-sort-alist-function)
1154            'gnus-group-sort-topic)
1155       (setq gnus-group-change-level-function 'gnus-topic-change-level)
1156       (setq gnus-goto-missing-group-function 'gnus-topic-goto-missing-group)
1157       (make-local-hook 'gnus-check-bogus-groups-hook)
1158       (add-hook 'gnus-check-bogus-groups-hook 'gnus-topic-clean-alist
1159                 nil 'local)
1160       (setq gnus-topology-checked-p nil)
1161       ;; We check the topology.
1162       (when gnus-newsrc-alist
1163         (gnus-topic-check-topology))
1164       (gnus-run-hooks 'gnus-topic-mode-hook))
1165     ;; Remove topic infestation.
1166     (unless gnus-topic-mode
1167       (remove-hook 'gnus-summary-exit-hook 'gnus-topic-update-topic)
1168       (setq gnus-group-change-level-function nil)
1169       (remove-hook 'gnus-check-bogus-groups-hook 'gnus-topic-clean-alist)
1170       (setq gnus-group-prepare-function 'gnus-group-prepare-flat)
1171       (setq gnus-group-sort-alist-function 'gnus-group-sort-flat))
1172     (when redisplay
1173       (gnus-group-list-groups))))
1174
1175 (defun gnus-topic-select-group (&optional all)
1176   "Select this newsgroup.
1177 No article is selected automatically.
1178 If the group is opened, just switch the summary buffer.
1179 If ALL is non-nil, already read articles become readable.
1180 If ALL is a number, fetch this number of articles.
1181
1182 If performed over a topic line, toggle folding the topic."
1183   (interactive "P")
1184   (if (gnus-group-topic-p)
1185       (let ((gnus-group-list-mode
1186              (if all (cons (if (numberp all) all 7) t) gnus-group-list-mode)))
1187         (gnus-topic-fold all)
1188         (gnus-dribble-touch))
1189     (gnus-group-select-group all)))
1190
1191 (defun gnus-mouse-pick-topic (e)
1192   "Select the group or topic under the mouse pointer."
1193   (interactive "e")
1194   (mouse-set-point e)
1195   (gnus-topic-read-group nil))
1196
1197 (defun gnus-topic-expire-articles (topic)
1198   "Expire articles in this topic or group."
1199   (interactive (list (gnus-group-topic-name)))
1200   (if (not topic)
1201       (call-interactively 'gnus-group-expire-articles)
1202     (save-excursion
1203       (gnus-message 5 "Expiring groups in %s..." topic)
1204       (let ((gnus-group-marked
1205              (mapcar (lambda (entry) (car (nth 2 entry)))
1206                      (gnus-topic-find-groups topic gnus-level-killed t
1207                                              nil t))))
1208         (gnus-group-expire-articles nil))
1209       (gnus-message 5 "Expiring groups in %s...done" topic))))
1210
1211 (defun gnus-topic-catchup-articles (topic)
1212   "Catchup this topic or group.
1213 Also see `gnus-group-catchup'."
1214   (interactive (list (gnus-group-topic-name)))
1215   (if (not topic)
1216       (call-interactively 'gnus-group-catchup-current)
1217     (save-excursion
1218       (let* ((groups
1219              (mapcar (lambda (entry) (car (nth 2 entry)))
1220                      (gnus-topic-find-groups topic gnus-level-killed t
1221                                              nil t)))
1222              (buffer-read-only nil)
1223              (gnus-group-marked groups))
1224         (gnus-group-catchup-current)
1225         (mapcar 'gnus-topic-update-topics-containing-group groups)))))
1226
1227 (defun gnus-topic-read-group (&optional all no-article group)
1228   "Read news in this newsgroup.
1229 If the prefix argument ALL is non-nil, already read articles become
1230 readable.  IF ALL is a number, fetch this number of articles.  If the
1231 optional argument NO-ARTICLE is non-nil, no article will be
1232 auto-selected upon group entry.  If GROUP is non-nil, fetch that
1233 group.
1234
1235 If performed over a topic line, toggle folding the topic."
1236   (interactive "P")
1237   (if (gnus-group-topic-p)
1238       (let ((gnus-group-list-mode
1239              (if all (cons (if (numberp all) all 7) t) gnus-group-list-mode)))
1240         (gnus-topic-fold all))
1241     (gnus-group-read-group all no-article group)))
1242
1243 (defun gnus-topic-create-topic (topic parent &optional previous full-topic)
1244   "Create a new TOPIC under PARENT.
1245 When used interactively, PARENT will be the topic under point."
1246   (interactive
1247    (list
1248     (read-string "New topic: ")
1249     (gnus-current-topic)))
1250   ;; Check whether this topic already exists.
1251   (when (gnus-topic-find-topology topic)
1252     (error "Topic already exists"))
1253   (unless parent
1254     (setq parent (caar gnus-topic-topology)))
1255   (let ((top (cdr (gnus-topic-find-topology parent)))
1256         (full-topic (or full-topic (list (list topic 'visible nil nil)))))
1257     (unless top
1258       (error "No such parent topic: %s" parent))
1259     (if previous
1260         (progn
1261           (while (and (cdr top)
1262                       (not (equal (caaadr top) previous)))
1263             (setq top (cdr top)))
1264           (setcdr top (cons full-topic (cdr top))))
1265       (nconc top (list full-topic)))
1266     (unless (assoc topic gnus-topic-alist)
1267       (push (list topic) gnus-topic-alist)))
1268   (gnus-topic-enter-dribble)
1269   (gnus-group-list-groups)
1270   (gnus-topic-goto-topic topic))
1271
1272 ;; FIXME:
1273 ;;  1. When the marked groups are overlapped with the process
1274 ;;     region, the behavior of move or remove is not right.
1275 ;;  2. Can't process on several marked groups with a same name,
1276 ;;     because gnus-group-marked only keeps one copy.
1277
1278 (defun gnus-topic-move-group (n topic &optional copyp)
1279   "Move the next N groups to TOPIC.
1280 If COPYP, copy the groups instead."
1281   (interactive
1282    (list current-prefix-arg
1283          (gnus-completing-read "Move to topic" gnus-topic-alist nil t
1284                                'gnus-topic-history)))
1285   (let ((use-marked (and (not n) (not (gnus-region-active-p))
1286                          gnus-group-marked t))
1287         (groups (gnus-group-process-prefix n))
1288         (topicl (assoc topic gnus-topic-alist))
1289         (start-topic (gnus-group-topic-name))
1290         (start-group (progn (forward-line 1) (gnus-group-group-name)))
1291         entry)
1292     (if (and (not groups) (not copyp) start-topic)
1293         (gnus-topic-move start-topic topic)
1294       (mapcar
1295        (lambda (g)
1296          (gnus-group-remove-mark g use-marked)
1297          (when (and
1298                 (setq entry (assoc (gnus-current-topic) gnus-topic-alist))
1299                 (not copyp))
1300            (setcdr entry (gnus-delete-first g (cdr entry))))
1301          (nconc topicl (list g)))
1302        groups)
1303       (gnus-topic-enter-dribble)
1304       (if start-group
1305           (gnus-group-goto-group start-group)
1306         (gnus-topic-goto-topic start-topic))
1307       (gnus-group-list-groups))))
1308
1309 (defun gnus-topic-remove-group (&optional n)
1310   "Remove the current group from the topic."
1311   (interactive "P")
1312   (let ((use-marked (and (not n) (not (gnus-region-active-p))
1313                          gnus-group-marked t))
1314         (groups (gnus-group-process-prefix n)))
1315     (mapcar
1316      (lambda (group)
1317        (gnus-group-remove-mark group use-marked)
1318        (let ((topicl (assoc (gnus-current-topic) gnus-topic-alist))
1319              (buffer-read-only nil))
1320          (when (and topicl group)
1321            (gnus-delete-line)
1322            (gnus-delete-first group topicl))
1323          (gnus-topic-update-topic)))
1324      groups)
1325     (gnus-topic-enter-dribble)
1326     (gnus-group-position-point)))
1327
1328 (defun gnus-topic-copy-group (n topic)
1329   "Copy the current group to a topic."
1330   (interactive
1331    (list current-prefix-arg
1332          (completing-read "Copy to topic: " gnus-topic-alist nil t)))
1333   (gnus-topic-move-group n topic t))
1334
1335 (defun gnus-topic-kill-group (&optional n discard)
1336   "Kill the next N groups."
1337   (interactive "P")
1338   (if (gnus-group-topic-p)
1339       (let ((topic (gnus-group-topic-name)))
1340         (push (cons
1341                (gnus-topic-find-topology topic)
1342                (assoc topic gnus-topic-alist))
1343               gnus-topic-killed-topics)
1344         (gnus-topic-remove-topic nil t)
1345         (gnus-topic-find-topology topic nil nil gnus-topic-topology)
1346         (gnus-topic-enter-dribble))
1347     (gnus-group-kill-group n discard)
1348     (if (not (gnus-group-topic-p))
1349         (gnus-topic-update-topic)
1350       ;; Move up one line so that we update the right topic.
1351       (forward-line -1)
1352       (gnus-topic-update-topic)
1353       (forward-line 1))))
1354
1355 (defun gnus-topic-yank-group (&optional arg)
1356   "Yank the last topic."
1357   (interactive "p")
1358   (if gnus-topic-killed-topics
1359       (let* ((previous
1360               (or (gnus-group-topic-name)
1361                   (gnus-topic-next-topic (gnus-current-topic))))
1362              (data (pop gnus-topic-killed-topics))
1363              (alist (cdr data))
1364              (item (cdar data)))
1365         (push alist gnus-topic-alist)
1366         (gnus-topic-create-topic
1367          (caar item) (gnus-topic-parent-topic previous) previous
1368          item)
1369         (gnus-topic-enter-dribble)
1370         (gnus-topic-goto-topic (caar item)))
1371     (let* ((prev (gnus-group-group-name))
1372            (gnus-topic-inhibit-change-level t)
1373            (gnus-group-indentation
1374             (make-string
1375              (* gnus-topic-indent-level
1376                 (or (save-excursion
1377                       (gnus-topic-goto-topic (gnus-current-topic))
1378                       (gnus-group-topic-level))
1379                     0))
1380              ? ))
1381            yanked alist)
1382       ;; We first yank the groups the normal way...
1383       (setq yanked (gnus-group-yank-group arg))
1384       ;; Then we enter the yanked groups into the topics they belong
1385       ;; to.
1386       (setq alist (assoc (save-excursion
1387                            (forward-line -1)
1388                            (gnus-current-topic))
1389                          gnus-topic-alist))
1390       (when (stringp yanked)
1391         (setq yanked (list yanked)))
1392       (if (not prev)
1393           (nconc alist yanked)
1394         (if (not (cdr alist))
1395             (setcdr alist (nconc yanked (cdr alist)))
1396           (while (cdr alist)
1397             (when (equal (cadr alist) prev)
1398               (setcdr alist (nconc yanked (cdr alist)))
1399               (setq alist nil))
1400             (setq alist (cdr alist))))))
1401     (gnus-topic-update-topic)))
1402
1403 (defun gnus-topic-hide-topic (&optional permanent)
1404   "Hide the current topic.
1405 If PERMANENT, make it stay hidden in subsequent sessions as well."
1406   (interactive "P")
1407   (when (gnus-current-topic)
1408     (gnus-topic-goto-topic (gnus-current-topic))
1409     (if permanent
1410         (setcar (cddr
1411                  (cadr
1412                   (gnus-topic-find-topology (gnus-current-topic))))
1413                 'hidden))
1414     (gnus-topic-remove-topic nil nil)))
1415
1416 (defun gnus-topic-show-topic (&optional permanent)
1417   "Show the hidden topic.
1418 If PERMANENT, make it stay shown in subsequent sessions as well."
1419   (interactive "P")
1420   (when (gnus-group-topic-p)
1421     (if (not permanent)
1422         (gnus-topic-remove-topic t nil)
1423       (let ((topic
1424              (gnus-topic-find-topology
1425               (completing-read "Show topic: " gnus-topic-alist nil t))))
1426         (setcar (cddr (cadr topic)) nil)
1427         (setcar (cdr (cadr topic)) 'visible)
1428         (gnus-group-list-groups)))))
1429
1430 (defun gnus-topic-mark-topic (topic &optional unmark non-recursive)
1431   "Mark all groups in the TOPIC with the process mark.
1432 If NON-RECURSIVE (which is the prefix) is t, don't mark its subtopics."
1433   (interactive (list (gnus-group-topic-name)
1434                      nil
1435                      (and current-prefix-arg t)))
1436   (if (not topic)
1437       (call-interactively 'gnus-group-mark-group)
1438     (save-excursion
1439       (let ((groups (gnus-topic-find-groups topic gnus-level-killed t nil
1440                                             (not non-recursive))))
1441         (while groups
1442           (funcall (if unmark 'gnus-group-remove-mark 'gnus-group-set-mark)
1443                    (gnus-info-group (nth 2 (pop groups)))))))))
1444
1445 (defun gnus-topic-unmark-topic (topic &optional dummy non-recursive)
1446   "Remove the process mark from all groups in the TOPIC.
1447 If NON-RECURSIVE (which is the prefix) is t, don't unmark its subtopics."
1448   (interactive (list (gnus-group-topic-name)
1449                      nil
1450                      (and current-prefix-arg t)))
1451   (if (not topic)
1452       (call-interactively 'gnus-group-unmark-group)
1453     (gnus-topic-mark-topic topic t non-recursive)))
1454
1455 (defun gnus-topic-get-new-news-this-topic (&optional n)
1456   "Check for new news in the current topic."
1457   (interactive "P")
1458   (if (not (gnus-group-topic-p))
1459       (gnus-group-get-new-news-this-group n)
1460     (let* ((topic (gnus-group-topic-name))
1461            (data (cadr (gnus-topic-find-topology topic))))
1462       (save-excursion
1463         (gnus-topic-mark-topic topic nil (and n t))
1464         (gnus-group-get-new-news-this-group))
1465       (gnus-topic-remove-topic (eq 'visible (cadr data))))))
1466
1467 (defun gnus-topic-move-matching (regexp topic &optional copyp)
1468   "Move all groups that match REGEXP to some topic."
1469   (interactive
1470    (let (topic)
1471      (nreverse
1472       (list
1473        (setq topic (completing-read "Move to topic: " gnus-topic-alist nil t))
1474        (read-string (format "Move to %s (regexp): " topic))))))
1475   (gnus-group-mark-regexp regexp)
1476   (gnus-topic-move-group nil topic copyp))
1477
1478 (defun gnus-topic-copy-matching (regexp topic &optional copyp)
1479   "Copy all groups that match REGEXP to some topic."
1480   (interactive
1481    (let (topic)
1482      (nreverse
1483       (list
1484        (setq topic (completing-read "Copy to topic: " gnus-topic-alist nil t))
1485        (read-string (format "Copy to %s (regexp): " topic))))))
1486   (gnus-topic-move-matching regexp topic t))
1487
1488 (defun gnus-topic-delete (topic)
1489   "Delete a topic."
1490   (interactive (list (gnus-group-topic-name)))
1491   (unless topic
1492     (error "No topic to be deleted"))
1493   (let ((entry (assoc topic gnus-topic-alist))
1494         (buffer-read-only nil))
1495     (when (cdr entry)
1496       (error "Topic not empty"))
1497     ;; Delete if visible.
1498     (when (gnus-topic-goto-topic topic)
1499       (gnus-delete-line))
1500     ;; Remove from alist.
1501     (setq gnus-topic-alist (delq entry gnus-topic-alist))
1502     ;; Remove from topology.
1503     (gnus-topic-find-topology topic nil nil 'delete)
1504     (gnus-dribble-touch)))
1505
1506 (defun gnus-topic-rename (old-name new-name)
1507   "Rename a topic."
1508   (interactive
1509    (let ((topic (gnus-current-topic)))
1510      (list topic
1511            (read-string (format "Rename %s to: " topic) topic))))
1512   ;; Check whether the new name exists.
1513   (when (gnus-topic-find-topology new-name)
1514     (error "Topic '%s' already exists" new-name))
1515   ;; "nil" is an invalid name, for reasons I'd rather not go
1516   ;; into here.  Trust me.
1517   (when (equal new-name "nil")
1518     (error "Invalid name: %s" nil))
1519   ;; Do the renaming.
1520   (let ((top (gnus-topic-find-topology old-name))
1521         (entry (assoc old-name gnus-topic-alist)))
1522     (when top
1523       (setcar (cadr top) new-name))
1524     (when entry
1525       (setcar entry new-name))
1526     (forward-line -1)
1527     (gnus-dribble-touch)
1528     (gnus-group-list-groups)
1529     (forward-line 1)))
1530
1531 (defun gnus-topic-indent (&optional unindent)
1532   "Indent a topic -- make it a sub-topic of the previous topic.
1533 If UNINDENT, remove an indentation."
1534   (interactive "P")
1535   (if unindent
1536       (gnus-topic-unindent)
1537     (let* ((topic (gnus-current-topic))
1538            (parent (gnus-topic-previous-topic topic))
1539            (buffer-read-only nil))
1540       (unless parent
1541         (error "Nothing to indent %s into" topic))
1542       (when topic
1543         (gnus-topic-goto-topic topic)
1544         (gnus-topic-kill-group)
1545         (push (cdar gnus-topic-killed-topics) gnus-topic-alist)
1546         (gnus-topic-create-topic
1547          topic parent nil (cdar (car gnus-topic-killed-topics)))
1548         (pop gnus-topic-killed-topics)
1549         (or (gnus-topic-goto-topic topic)
1550             (gnus-topic-goto-topic parent))))))
1551
1552 (defun gnus-topic-unindent ()
1553   "Unindent a topic."
1554   (interactive)
1555   (let* ((topic (gnus-current-topic))
1556          (parent (gnus-topic-parent-topic topic))
1557          (grandparent (gnus-topic-parent-topic parent)))
1558     (unless grandparent
1559       (error "Nothing to indent %s into" topic))
1560     (when topic
1561       (gnus-topic-goto-topic topic)
1562       (gnus-topic-kill-group)
1563       (push (cdar gnus-topic-killed-topics) gnus-topic-alist)
1564       (gnus-topic-create-topic
1565        topic grandparent (gnus-topic-next-topic parent)
1566        (cdar (car gnus-topic-killed-topics)))
1567       (pop gnus-topic-killed-topics)
1568       (gnus-topic-goto-topic topic))))
1569
1570 (defun gnus-topic-list-active (&optional force)
1571   "List all groups that Gnus knows about in a topicsified fashion.
1572 If FORCE, always re-read the active file."
1573   (interactive "P")
1574   (when force
1575     (gnus-get-killed-groups))
1576   (gnus-topic-grok-active force)
1577   (let ((gnus-topic-topology gnus-topic-active-topology)
1578         (gnus-topic-alist gnus-topic-active-alist)
1579         gnus-killed-list gnus-zombie-list)
1580     (gnus-group-list-groups gnus-level-killed nil 1)))
1581
1582 (defun gnus-topic-toggle-display-empty-topics ()
1583   "Show/hide topics that have no unread articles."
1584   (interactive)
1585   (setq gnus-topic-display-empty-topics
1586         (not gnus-topic-display-empty-topics))
1587   (gnus-group-list-groups)
1588   (message "%s empty topics"
1589            (if gnus-topic-display-empty-topics
1590                "Showing" "Hiding")))
1591
1592 ;;; Topic sorting functions
1593
1594 (defun gnus-topic-edit-parameters (group)
1595   "Edit the group parameters of GROUP.
1596 If performed on a topic, edit the topic parameters instead."
1597   (interactive (list (gnus-group-group-name)))
1598   (if group
1599       (gnus-group-edit-group-parameters group)
1600     (if (not (gnus-group-topic-p))
1601         (error "Nothing to edit on the current line")
1602       (let ((topic (gnus-group-topic-name)))
1603         (gnus-edit-form
1604          (gnus-topic-parameters topic)
1605          (format "Editing the topic parameters for `%s'."
1606                  (or group topic))
1607          `(lambda (form)
1608             (gnus-topic-set-parameters ,topic form)))))))
1609
1610 (defun gnus-group-sort-topic (func reverse)
1611   "Sort groups in the topics according to FUNC and REVERSE."
1612   (let ((alist gnus-topic-alist))
1613     (while alist
1614       ;; !!!Sometimes nil elements sneak into the alist,
1615       ;; for some reason or other.
1616       (setcar alist (delq nil (car alist)))
1617       (setcar alist (delete "dummy.group" (car alist)))
1618       (gnus-topic-sort-topic (pop alist) func reverse))))
1619
1620 (defun gnus-topic-sort-topic (topic func reverse)
1621   ;; Each topic only lists the name of the group, while
1622   ;; the sort predicates expect group infos as inputs.
1623   ;; So we first transform the group names into infos,
1624   ;; then sort, and then transform back into group names.
1625   (setcdr
1626    topic
1627    (mapcar
1628     (lambda (info) (gnus-info-group info))
1629     (sort
1630      (mapcar
1631       (lambda (group) (gnus-get-info group))
1632       (cdr topic))
1633      func)))
1634   ;; Do the reversal, if necessary.
1635   (when reverse
1636     (setcdr topic (nreverse (cdr topic)))))
1637
1638 (defun gnus-topic-sort-groups (func &optional reverse)
1639   "Sort the current topic according to FUNC.
1640 If REVERSE, reverse the sorting order."
1641   (interactive (list gnus-group-sort-function current-prefix-arg))
1642   (let ((topic (assoc (gnus-current-topic) gnus-topic-alist)))
1643     (gnus-topic-sort-topic
1644      topic (gnus-make-sort-function func) reverse)
1645     (gnus-group-list-groups)))
1646
1647 (defun gnus-topic-sort-groups-by-alphabet (&optional reverse)
1648   "Sort the current topic alphabetically by group name.
1649 If REVERSE, sort in reverse order."
1650   (interactive "P")
1651   (gnus-topic-sort-groups 'gnus-group-sort-by-alphabet reverse))
1652
1653 (defun gnus-topic-sort-groups-by-unread (&optional reverse)
1654   "Sort the current topic by number of unread articles.
1655 If REVERSE, sort in reverse order."
1656   (interactive "P")
1657   (gnus-topic-sort-groups 'gnus-group-sort-by-unread reverse))
1658
1659 (defun gnus-topic-sort-groups-by-level (&optional reverse)
1660   "Sort the current topic by group level.
1661 If REVERSE, sort in reverse order."
1662   (interactive "P")
1663   (gnus-topic-sort-groups 'gnus-group-sort-by-level reverse))
1664
1665 (defun gnus-topic-sort-groups-by-score (&optional reverse)
1666   "Sort the current topic by group score.
1667 If REVERSE, sort in reverse order."
1668   (interactive "P")
1669   (gnus-topic-sort-groups 'gnus-group-sort-by-score reverse))
1670
1671 (defun gnus-topic-sort-groups-by-rank (&optional reverse)
1672   "Sort the current topic by group rank.
1673 If REVERSE, sort in reverse order."
1674   (interactive "P")
1675   (gnus-topic-sort-groups 'gnus-group-sort-by-rank reverse))
1676
1677 (defun gnus-topic-sort-groups-by-method (&optional reverse)
1678   "Sort the current topic alphabetically by backend name.
1679 If REVERSE, sort in reverse order."
1680   (interactive "P")
1681   (gnus-topic-sort-groups 'gnus-group-sort-by-method reverse))
1682
1683 (defun gnus-topic-sort-groups-by-server (&optional reverse)
1684   "Sort the current topic alphabetically by server name.
1685 If REVERSE, sort in reverse order."
1686   (interactive "P")
1687   (gnus-topic-sort-groups 'gnus-group-sort-by-server reverse))
1688
1689 (defun gnus-topic-sort-topics-1 (top reverse)
1690   (if (cdr top)
1691       (let ((subtop
1692              (mapcar (gnus-byte-compile
1693                       `(lambda (top)
1694                          (gnus-topic-sort-topics-1 top ,reverse)))
1695                      (sort (cdr top)
1696                            (lambda (t1 t2)
1697                              (string-lessp (caar t1) (caar t2)))))))
1698         (setcdr top (if reverse (reverse subtop) subtop))))
1699   top)
1700
1701 (defun gnus-topic-sort-topics (&optional topic reverse)
1702   "Sort topics in TOPIC alphabetically by topic name.
1703 If REVERSE, reverse the sorting order."
1704   (interactive
1705    (list (completing-read "Sort topics in : " gnus-topic-alist nil t
1706                           (gnus-current-topic))
1707          current-prefix-arg))
1708   (let ((topic-topology (or (and topic (cdr (gnus-topic-find-topology topic)))
1709                             gnus-topic-topology)))
1710     (gnus-topic-sort-topics-1 topic-topology reverse)
1711     (gnus-topic-enter-dribble)
1712     (gnus-group-list-groups)
1713     (gnus-topic-goto-topic topic)))
1714
1715 (defun gnus-topic-move (current to)
1716   "Move the CURRENT topic to TO."
1717   (interactive
1718    (list
1719     (gnus-group-topic-name)
1720     (completing-read "Move to topic: " gnus-topic-alist nil t)))
1721   (unless (and current to)
1722     (error "Can't find topic"))
1723   (let ((current-top (cdr (gnus-topic-find-topology current)))
1724         (to-top (cdr (gnus-topic-find-topology to))))
1725     (unless current-top
1726       (error "Can't find topic `%s'" current))
1727     (unless to-top
1728       (error "Can't find topic `%s'" to))
1729     (if (gnus-topic-find-topology to current-top 0);; Don't care the level
1730         (error "Can't move `%s' to its sub-level" current))
1731     (gnus-topic-find-topology current nil nil 'delete)
1732     (while (cdr to-top)
1733       (setq to-top (cdr to-top)))
1734     (setcdr to-top (list current-top))
1735     (gnus-topic-enter-dribble)
1736     (gnus-group-list-groups)
1737     (gnus-topic-goto-topic current)))
1738
1739 (defun gnus-subscribe-topics (newsgroup)
1740   (catch 'end
1741     (let (match gnus-group-change-level-function)
1742       (dolist (topic (gnus-topic-list))
1743         (when (and (setq match (cdr (assq 'subscribe
1744                                           (gnus-topic-parameters topic))))
1745                    (string-match match newsgroup))
1746           ;; Just subscribe the group.
1747           (gnus-subscribe-alphabetically newsgroup)
1748           ;; Add the group to the topic.
1749           (nconc (assoc topic gnus-topic-alist) (list newsgroup))
1750           ;; if this topic specifies a default level, use it
1751           (let ((subscribe-level (cdr (assq 'subscribe-level
1752                                             (gnus-topic-parameters topic)))))
1753             (when subscribe-level
1754                 (gnus-group-change-level newsgroup subscribe-level
1755                                          gnus-level-default-subscribed)))
1756           (throw 'end t)))
1757       nil)))
1758
1759 (provide 'gnus-topic)
1760
1761 ;;; gnus-topic.el ends here