git.chise.org Git - elisp/gnus.git-/blob - lisp/gnus-topic.el

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