cgit.sxemacs.org Git - gnus/blob - lisp/gnus-topic.el

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