lisp/ibuf-ext.el

   1 ;;; ibuf-ext.el --- extensions for ibuffer
   2
   3 ;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
   4 ;;   2005, 2006 Free Software Foundation, Inc.
   5
   6 ;; Author: Colin Walters <walters@verbum.org>
   7 ;; Maintainer: John Paul Wallington <jpw@gnu.org>
   8 ;; Created: 2 Dec 2001
   9 ;; Keywords: buffer, convenience
  10
  11 ;; This file is part of GNU Emacs.
  12
  13 ;; This program is free software; you can redistribute it and/or
  14 ;; modify it under the terms of the GNU General Public License as
  15 ;; published by the Free Software Foundation; either version 2, or (at
  16 ;; your option) any later version.
  17
  18 ;; This program is distributed in the hope that it will be useful, but
  19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 ;; General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with this program ; see the file COPYING.  If not, write to
  25 ;; the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  26 ;; Boston, MA 02110-1301, USA.
  27
  28 ;;; Commentary:
  29
  30 ;; These functions should be automatically loaded when called, but you
  31 ;; can explicity (require 'ibuf-ext) in your ~/.emacs to have them
  32 ;; preloaded.
  33
  34 ;;; Code:
  35
  36 (require 'ibuffer)
  37
  38 (eval-when-compile
  39   (require 'ibuf-macs)
  40   (require 'cl))
  41
  42 ;;; Utility functions
  43 (defun ibuffer-delete-alist (key alist)
  44   "Delete all entries in ALIST that have a key equal to KEY."
  45   (let (entry)
  46     (while (setq entry (assoc key alist))
  47       (setq alist (delete entry alist)))
  48     alist))
  49
  50 ;; borrowed from Gnus
  51 (defun ibuffer-remove-duplicates (list)
  52   "Return a copy of LIST with duplicate elements removed."
  53   (let ((new nil)
  54         (tail list))
  55     (while tail
  56       (or (member (car tail) new)
  57           (setq new (cons (car tail) new)))
  58       (setq tail (cdr tail)))
  59     (nreverse new)))
  60
  61 (defun ibuffer-split-list (ibuffer-split-list-fn ibuffer-split-list-elts)
  62   (let ((hip-crowd nil)
  63         (lamers nil))
  64     (dolist (ibuffer-split-list-elt ibuffer-split-list-elts)
  65       (if (funcall ibuffer-split-list-fn ibuffer-split-list-elt)
  66           (push ibuffer-split-list-elt hip-crowd)
  67         (push ibuffer-split-list-elt lamers)))
  68     ;; Too bad Emacs Lisp doesn't have multiple values.
  69     (list (nreverse hip-crowd) (nreverse lamers))))
  70
  71 (defcustom ibuffer-never-show-predicates nil
  72   "A list of predicates (a regexp or function) for buffers not to display.
  73 If a regexp, then it will be matched against the buffer's name.
  74 If a function, it will be called with the buffer as an argument, and
  75 should return non-nil if this buffer should not be shown."
  76   :type '(repeat (choice regexp function))
  77   :require 'ibuf-ext
  78   :group 'ibuffer)
  79
  80 (defcustom ibuffer-always-show-predicates nil
  81   "A list of predicates (a regexp or function) for buffers to always display.
  82 If a regexp, then it will be matched against the buffer's name.
  83 If a function, it will be called with the buffer as an argument, and
  84 should return non-nil if this buffer should be shown.
  85 Note that buffers matching one of these predicates will be shown
  86 regardless of any active filters in this buffer."
  87   :type '(repeat (choice regexp function))
  88   :group 'ibuffer)
  89
  90 (defvar ibuffer-tmp-hide-regexps nil
  91   "A list of regexps which should match buffer names to not show.")
  92
  93 (defvar ibuffer-tmp-show-regexps nil
  94   "A list of regexps which should match buffer names to always show.")
  95
  96 (defvar ibuffer-auto-mode nil
  97   "If non-nil, Ibuffer auto-mode should be enabled for this buffer.
  98 Do not set this variable directly!  Use the function
  99 `ibuffer-auto-mode' instead.")
 100
 101 (defvar ibuffer-auto-buffers-changed nil)
 102
 103 (defcustom ibuffer-saved-filters '(("gnus"
 104                                     ((or (mode . message-mode)
 105                                          (mode . mail-mode)
 106                                          (mode . gnus-group-mode)
 107                                          (mode . gnus-summary-mode)
 108                                          (mode . gnus-article-mode))))
 109                                    ("programming"
 110                                     ((or (mode . emacs-lisp-mode)
 111                                          (mode . cperl-mode)
 112                                          (mode . c-mode)
 113                                          (mode . java-mode)
 114                                          (mode . idl-mode)
 115                                          (mode . lisp-mode)))))
 116
 117   "An alist of filter qualifiers to switch between.
 118
 119 This variable should look like ((\"STRING\" QUALIFIERS)
 120                                 (\"STRING\" QUALIFIERS) ...), where
 121 QUALIFIERS is a list of the same form as
 122 `ibuffer-filtering-qualifiers'.
 123 See also the variables `ibuffer-filtering-qualifiers',
 124 `ibuffer-filtering-alist', and the functions
 125 `ibuffer-switch-to-saved-filters', `ibuffer-save-filters'."
 126   :type '(repeat sexp)
 127   :group 'ibuffer)
 128
 129 (defvar ibuffer-filtering-qualifiers nil
 130   "A list like (SYMBOL . QUALIFIER) which filters the current buffer list.
 131 See also `ibuffer-filtering-alist'.")
 132
 133 ;; This is now frobbed by `define-ibuffer-filter'.
 134 (defvar ibuffer-filtering-alist nil
 135   "An alist of (SYMBOL DESCRIPTION FUNCTION) which describes a filter.
 136
 137 You most likely do not want to modify this variable directly; see
 138 `define-ibuffer-filter'.
 139
 140 SYMBOL is the symbolic name of the filter.  DESCRIPTION is used when
 141 displaying information to the user.  FUNCTION is given a buffer and
 142 the value of the qualifier, and returns non-nil if and only if the
 143 buffer should be displayed.")
 144
 145 (defcustom ibuffer-filter-format-alist nil
 146   "An alist which has special formats used when a filter is active.
 147 The contents of this variable should look like:
 148  ((FILTER (FORMAT FORMAT ...)) (FILTER (FORMAT FORMAT ...)) ...)
 149
 150 For example, suppose that when you add a filter for buffers whose
 151 major mode is `emacs-lisp-mode', you only want to see the mark and the
 152 name of the buffer.  You could accomplish that by adding:
 153  (mode ((mark \" \" name)))
 154 to this variable."
 155   :type '(repeat (list :tag "Association" (symbol :tag "Filter")
 156                        (list :tag "Formats" (repeat (sexp :tag "Format")))))
 157   :group 'ibuffer)
 158
 159 (defvar ibuffer-cached-filter-formats nil)
 160 (defvar ibuffer-compiled-filter-formats nil)
 161
 162 (defvar ibuffer-filter-groups nil
 163   "A list like ((\"NAME\" ((SYMBOL . QUALIFIER) ...) ...) which groups buffers.
 164 The SYMBOL should be one from `ibuffer-filtering-alist'.
 165 The QUALIFIER should be the same as QUALIFIER in
 166 `ibuffer-filtering-qualifiers'.")
 167
 168 (defcustom ibuffer-show-empty-filter-groups t
 169   "If non-nil, then show the names of filter groups which are empty."
 170   :type 'boolean
 171   :group 'ibuffer)
 172
 173 (defcustom ibuffer-saved-filter-groups nil
 174   "An alist of filtering groups to switch between.
 175
 176 This variable should look like ((\"STRING\" QUALIFIERS)
 177                                 (\"STRING\" QUALIFIERS) ...), where
 178 QUALIFIERS is a list of the same form as
 179 `ibuffer-filtering-qualifiers'.
 180
 181 See also the variables `ibuffer-filter-groups',
 182 `ibuffer-filtering-qualifiers', `ibuffer-filtering-alist', and the
 183 functions `ibuffer-switch-to-saved-filter-group',
 184 `ibuffer-save-filter-group'."
 185   :type '(repeat sexp)
 186   :group 'ibuffer)
 187
 188 (defvar ibuffer-hidden-filter-groups nil
 189   "A list of filtering groups which are currently hidden.")
 190
 191 (defvar ibuffer-filter-group-kill-ring nil)
 192
 193 (defcustom ibuffer-old-time 72
 194   "The number of hours before a buffer is considered \"old\"."
 195   :type '(choice (const :tag "72 hours (3 days)" 72)
 196                  (const :tag "48 hours (2 days)" 48)
 197                  (const :tag "24 hours (1 day)" 24)
 198                  (integer :tag "hours"))
 199   :group 'ibuffer)
 200
 201 (defcustom ibuffer-save-with-custom t
 202   "If non-nil, then use Custom to save interactively changed variables.
 203 Currently, this only applies to `ibuffer-saved-filters' and
 204 `ibuffer-saved-filter-groups'."
 205   :type 'boolean
 206   :group 'ibuffer)
 207
 208 (defun ibuffer-ext-visible-p (buf all &optional ibuffer-buf)
 209   (or
 210    (ibuffer-buf-matches-predicates buf ibuffer-tmp-show-regexps)
 211    (and (not
 212          (or
 213           (ibuffer-buf-matches-predicates buf ibuffer-tmp-hide-regexps)
 214           (ibuffer-buf-matches-predicates buf ibuffer-never-show-predicates)))
 215         (or all
 216             (not
 217              (ibuffer-buf-matches-predicates buf ibuffer-maybe-show-predicates)))
 218         (or ibuffer-view-ibuffer
 219             (and ibuffer-buf
 220                  (not (eq ibuffer-buf buf))))
 221         (or
 222          (ibuffer-included-in-filters-p buf ibuffer-filtering-qualifiers)
 223          (ibuffer-buf-matches-predicates buf ibuffer-always-show-predicates)))))
 224
 225 (defun ibuffer-auto-update-changed ()
 226   (when (frame-or-buffer-changed-p 'ibuffer-auto-buffers-changed)
 227     (mapcar #'(lambda (buf)
 228                 (ignore-errors
 229                   (with-current-buffer buf
 230                     (when (and ibuffer-auto-mode
 231                                (eq major-mode 'ibuffer-mode))
 232                       (ibuffer-update nil t)))))
 233             (buffer-list))))
 234
 235 ;;;###autoload
 236 (defun ibuffer-auto-mode (&optional arg)
 237   "Toggle use of Ibuffer's auto-update facility.
 238 With numeric ARG, enable auto-update if and only if ARG is positive."
 239   (interactive)
 240   (unless (eq major-mode 'ibuffer-mode)
 241     (error "This buffer is not in Ibuffer mode"))
 242   (set (make-local-variable 'ibuffer-auto-mode)
 243        (if arg
 244            (plusp arg)
 245          (not ibuffer-auto-mode)))
 246   (frame-or-buffer-changed-p 'ibuffer-auto-buffers-changed)
 247   (add-hook 'post-command-hook 'ibuffer-auto-update-changed)
 248   (ibuffer-update-mode-name))
 249
 250 ;;;###autoload
 251 (defun ibuffer-mouse-filter-by-mode (event)
 252   "Enable or disable filtering by the major mode chosen via mouse."
 253   (interactive "e")
 254   (ibuffer-interactive-filter-by-mode event))
 255
 256 ;;;###autoload
 257 (defun ibuffer-interactive-filter-by-mode (event-or-point)
 258   "Enable or disable filtering by the major mode at point."
 259   (interactive "d")
 260   (if (eventp event-or-point)
 261       (posn-set-point (event-end event-or-point))
 262     (goto-char event-or-point))
 263   (let ((buf (ibuffer-current-buffer)))
 264     (if (assq 'mode ibuffer-filtering-qualifiers)
 265         (setq ibuffer-filtering-qualifiers
 266               (ibuffer-delete-alist 'mode ibuffer-filtering-qualifiers))
 267       (ibuffer-push-filter (cons 'mode
 268                                 (with-current-buffer buf
 269                                   major-mode)))))
 270   (ibuffer-update nil t))
 271
 272 ;;;###autoload
 273 (defun ibuffer-mouse-toggle-filter-group (event)
 274   "Toggle the display status of the filter group chosen with the mouse."
 275   (interactive "e")
 276   (ibuffer-toggle-filter-group-1 (save-excursion
 277                                    (mouse-set-point event)
 278                                    (point))))
 279
 280 ;;;###autoload
 281 (defun ibuffer-toggle-filter-group ()
 282   "Toggle the display status of the filter group on this line."
 283   (interactive)
 284   (ibuffer-toggle-filter-group-1 (point)))
 285
 286 (defun ibuffer-toggle-filter-group-1 (posn)
 287   (let ((name (get-text-property posn 'ibuffer-filter-group-name)))
 288     (unless (stringp name)
 289       (error "No filtering group name present"))
 290     (if (member name ibuffer-hidden-filter-groups)
 291         (setq ibuffer-hidden-filter-groups
 292               (delete name ibuffer-hidden-filter-groups))
 293       (push name ibuffer-hidden-filter-groups))
 294     (ibuffer-update nil t)))
 295
 296 ;;;###autoload
 297 (defun ibuffer-forward-filter-group (&optional count)
 298   "Move point forwards by COUNT filtering groups."
 299   (interactive "P")
 300   (unless count
 301     (setq count 1))
 302   (when (> count 0)
 303     (when (get-text-property (point) 'ibuffer-filter-group-name)
 304       (goto-char (next-single-property-change
 305                   (point) 'ibuffer-filter-group-name
 306                   nil (point-max))))
 307     (goto-char (next-single-property-change
 308                 (point) 'ibuffer-filter-group-name
 309                 nil (point-max)))
 310     (ibuffer-forward-filter-group (1- count)))
 311   (ibuffer-forward-line 0))
 312
 313 ;;;###autoload
 314 (defun ibuffer-backward-filter-group (&optional count)
 315   "Move point backwards by COUNT filtering groups."
 316   (interactive "P")
 317   (unless count
 318     (setq count 1))
 319   (when (> count 0)
 320     (when (get-text-property (point) 'ibuffer-filter-group-name)
 321       (goto-char (previous-single-property-change
 322                   (point) 'ibuffer-filter-group-name
 323                   nil (point-min))))
 324     (goto-char (previous-single-property-change
 325                 (point) 'ibuffer-filter-group-name
 326                 nil (point-min)))
 327     (ibuffer-backward-filter-group (1- count)))
 328   (when (= (point) (point-min))
 329     (goto-char (point-max))
 330     (ibuffer-backward-filter-group 1))
 331   (ibuffer-forward-line 0))
 332
 333 ;;;###autoload (autoload 'ibuffer-do-shell-command-pipe "ibuf-ext")
 334 (define-ibuffer-op shell-command-pipe (command)
 335   "Pipe the contents of each marked buffer to shell command COMMAND."
 336   (:interactive "sPipe to shell command: "
 337    :opstring "Shell command executed on"
 338    :modifier-p nil)
 339   (shell-command-on-region
 340    (point-min) (point-max) command
 341    (get-buffer-create "* ibuffer-shell-output*")))
 342
 343 ;;;###autoload (autoload 'ibuffer-do-shell-command-pipe-replace "ibuf-ext")
 344 (define-ibuffer-op shell-command-pipe-replace (command)
 345   "Replace the contents of marked buffers with output of pipe to COMMAND."
 346   (:interactive "sPipe to shell command (replace): "
 347    :opstring "Buffer contents replaced in"
 348    :active-opstring "replace buffer contents in"
 349    :dangerous t
 350    :modifier-p t)
 351   (with-current-buffer buf
 352     (shell-command-on-region (point-min) (point-max)
 353                              command nil t)))
 354
 355 ;;;###autoload (autoload 'ibuffer-do-shell-command-file "ibuf-ext")
 356 (define-ibuffer-op shell-command-file (command)
 357   "Run shell command COMMAND separately on files of marked buffers."
 358   (:interactive "sShell command on buffer's file: "
 359    :opstring "Shell command executed on"
 360    :modifier-p nil)
 361   (shell-command (concat command " "
 362                          (shell-quote-argument
 363                           (if buffer-file-name
 364                               buffer-file-name
 365                             (make-temp-file
 366                              (substring (buffer-name) 0 (min 10 (length (buffer-name))))))))))
 367
 368 ;;;###autoload (autoload 'ibuffer-do-eval "ibuf-ext")
 369 (define-ibuffer-op eval (form)
 370   "Evaluate FORM in each of the buffers.
 371 Does not display the buffer during evaluation. See
 372 `ibuffer-do-view-and-eval' for that."
 373   (:interactive
 374    (list
 375     (read-from-minibuffer
 376      "Eval in buffers (form): "
 377      nil read-expression-map t 'read-expression-history))
 378    :opstring "evaluated in"
 379    :modifier-p :maybe)
 380   (eval form))
 381
 382 ;;;###autoload (autoload 'ibuffer-do-view-and-eval "ibuf-ext")
 383 (define-ibuffer-op view-and-eval (form)
 384   "Evaluate FORM while displaying each of the marked buffers.
 385 To evaluate a form without viewing the buffer, see `ibuffer-do-eval'."
 386   (:interactive
 387    (list
 388     (read-from-minibuffer
 389      "Eval viewing in buffers (form): "
 390      nil read-expression-map t 'read-expression-history))
 391    :opstring "evaluated in"
 392    :complex t
 393    :modifier-p :maybe)
 394   (let ((ibuffer-buf (current-buffer)))
 395     (unwind-protect
 396         (progn
 397           (switch-to-buffer buf)
 398           (eval form))
 399       (switch-to-buffer ibuffer-buf))))
 400
 401 ;;;###autoload (autoload 'ibuffer-do-rename-uniquely "ibuf-ext")
 402 (define-ibuffer-op rename-uniquely ()
 403   "Rename marked buffers as with `rename-uniquely'."
 404   (:opstring "renamed"
 405    :modifier-p t)
 406   (rename-uniquely))
 407
 408 ;;;###autoload (autoload 'ibuffer-do-revert "ibuf-ext")
 409 (define-ibuffer-op revert ()
 410   "Revert marked buffers as with `revert-buffer'."
 411   (:dangerous t
 412    :opstring "reverted"
 413    :active-opstring "revert"
 414    :modifier-p :maybe)
 415   (revert-buffer t t))
 416
 417 ;;;###autoload (autoload 'ibuffer-do-replace-regexp "ibuf-ext")
 418 (define-ibuffer-op replace-regexp (from-str to-str)
 419   "Perform a `replace-regexp' in marked buffers."
 420   (:interactive
 421    (let* ((from-str (read-from-minibuffer "Replace regexp: "))
 422           (to-str (read-from-minibuffer (concat "Replace " from-str
 423                                                 " with: "))))
 424      (list from-str to-str))
 425    :opstring "replaced in"
 426    :complex t
 427    :modifier-p :maybe)
 428   (save-window-excursion
 429     (switch-to-buffer buf)
 430     (save-excursion
 431       (goto-char (point-min))
 432       (let ((case-fold-search ibuffer-case-fold-search))
 433         (while (re-search-forward from-str nil t)
 434           (replace-match to-str))))
 435     t))
 436
 437 ;;;###autoload (autoload 'ibuffer-do-query-replace "ibuf-ext")
 438 (define-ibuffer-op query-replace (&rest args)
 439   "Perform a `query-replace' in marked buffers."
 440   (:interactive
 441    (query-replace-read-args "Query replace" t t)
 442    :opstring "replaced in"
 443    :complex t
 444    :modifier-p :maybe)
 445   (save-window-excursion
 446     (switch-to-buffer buf)
 447     (save-excursion
 448       (let ((case-fold-search ibuffer-case-fold-search))
 449         (goto-char (point-min))
 450         (apply #'query-replace args)))
 451     t))
 452
 453 ;;;###autoload (autoload 'ibuffer-do-query-replace-regexp "ibuf-ext")
 454 (define-ibuffer-op query-replace-regexp (&rest args)
 455   "Perform a `query-replace-regexp' in marked buffers."
 456   (:interactive
 457    (query-replace-read-args "Query replace regexp" t t)
 458    :opstring "replaced in"
 459    :complex t
 460    :modifier-p :maybe)
 461   (save-window-excursion
 462     (switch-to-buffer buf)
 463     (save-excursion
 464       (let ((case-fold-search ibuffer-case-fold-search))
 465         (goto-char (point-min))
 466         (apply #'query-replace-regexp args)))
 467     t))
 468
 469 ;;;###autoload (autoload 'ibuffer-do-print "ibuf-ext")
 470 (define-ibuffer-op print ()
 471   "Print marked buffers as with `print-buffer'."
 472   (:opstring "printed"
 473    :modifier-p nil)
 474   (print-buffer))
 475
 476 ;;;###autoload
 477 (defun ibuffer-included-in-filters-p (buf filters)
 478   (not
 479    (memq nil ;; a filter will return nil if it failed
 480          (mapcar
 481           ;; filter should be like (TYPE . QUALIFIER), or
 482           ;; (or (TYPE . QUALIFIER) (TYPE . QUALIFIER) ...)
 483           #'(lambda (qual)
 484               (ibuffer-included-in-filter-p buf qual))
 485           filters))))
 486
 487 (defun ibuffer-included-in-filter-p (buf filter)
 488   (if (eq (car filter) 'not)
 489       (not (ibuffer-included-in-filter-p-1 buf (cdr filter)))
 490     (ibuffer-included-in-filter-p-1 buf filter)))
 491
 492 (defun ibuffer-included-in-filter-p-1 (buf filter)
 493   (not
 494    (not
 495     (case (car filter)
 496       (or
 497        (memq t (mapcar #'(lambda (x)
 498                            (ibuffer-included-in-filter-p buf x))
 499                        (cdr filter))))
 500       (saved
 501        (let ((data
 502               (assoc (cdr filter)
 503                      ibuffer-saved-filters)))
 504          (unless data
 505            (ibuffer-filter-disable)
 506            (error "Unknown saved filter %s" (cdr filter)))
 507          (ibuffer-included-in-filters-p buf (cadr data))))
 508       (t
 509        (let ((filterdat (assq (car filter)
 510                               ibuffer-filtering-alist)))
 511          ;; filterdat should be like (TYPE DESCRIPTION FUNC)
 512          ;; just a sanity check
 513         (unless filterdat
 514           (ibuffer-filter-disable)
 515           (error "Undefined filter %s" (car filter)))
 516         (not
 517          (not
 518           (funcall (caddr filterdat)
 519                    buf
 520                    (cdr filter))))))))))
 521
 522 (defun ibuffer-generate-filter-groups (bmarklist &optional noempty nodefault)
 523   (let ((filter-group-alist (if nodefault
 524                                 ibuffer-filter-groups
 525                               (append ibuffer-filter-groups
 526                                       (list (cons "Default" nil))))))
 527 ;;     (dolist (hidden ibuffer-hidden-filter-groups)
 528 ;;       (setq filter-group-alist (ibuffer-delete-alist
 529 ;;                                 hidden filter-group-alist)))
 530     (let ((vec (make-vector (length filter-group-alist) nil))
 531           (i 0))
 532       (dolist (filtergroup filter-group-alist)
 533         (let ((filterset (cdr filtergroup)))
 534           (multiple-value-bind (hip-crowd lamers)
 535               (ibuffer-split-list (lambda (bufmark)
 536                                     (ibuffer-included-in-filters-p (car bufmark)
 537                                                                    filterset))
 538                                   bmarklist)
 539             (aset vec i hip-crowd)
 540             (incf i)
 541             (setq bmarklist lamers))))
 542       (let (ret)
 543         (dotimes (j i ret)
 544           (let ((bufs (aref vec j)))
 545             (unless (and noempty (null bufs))
 546               (push (cons (car (nth j filter-group-alist))
 547                           bufs)
 548                     ret))))))))
 549
 550 ;;;###autoload
 551 (defun ibuffer-filters-to-filter-group (name)
 552   "Make the current filters into a filtering group."
 553   (interactive "sName for filtering group: ")
 554   (when (null ibuffer-filtering-qualifiers)
 555     (error "No filters in effect"))
 556   (push (cons name ibuffer-filtering-qualifiers) ibuffer-filter-groups)
 557   (ibuffer-filter-disable))
 558
 559 ;;;###autoload
 560 (defun ibuffer-set-filter-groups-by-mode ()
 561   "Set the current filter groups to filter by mode."
 562   (interactive)
 563   (setq ibuffer-filter-groups
 564         (mapcar (lambda (mode)
 565                   (cons (format "%s" mode) `((mode . ,mode))))
 566                 (let ((modes
 567                        (ibuffer-remove-duplicates
 568                         (mapcar (lambda (buf)
 569                                   (with-current-buffer buf major-mode))
 570                                 (buffer-list)))))
 571                   (if ibuffer-view-ibuffer
 572                       modes
 573                     (delq 'ibuffer-mode modes)))))
 574   (ibuffer-update nil t))
 575
 576 ;;;###autoload
 577 (defun ibuffer-pop-filter-group ()
 578   "Remove the first filter group."
 579   (interactive)
 580   (when (null ibuffer-filter-groups)
 581     (error "No filter groups active"))
 582   (setq ibuffer-hidden-filter-groups
 583         (delete (pop ibuffer-filter-groups)
 584                 ibuffer-hidden-filter-groups))
 585   (ibuffer-update nil t))
 586
 587 (defun ibuffer-read-filter-group-name (msg &optional nodefault noerror)
 588   (when (and (not noerror) (null ibuffer-filter-groups))
 589     (error "No filter groups active"))
 590   ;; `ibuffer-generate-filter-groups' returns all non-hidden filter
 591   ;; groups, possibly excluding empty groups or Default.
 592   ;; We add `ibuffer-hidden-filter-groups' to the list, excluding
 593   ;; Default if necessary.
 594   (completing-read msg (nconc
 595                         (ibuffer-generate-filter-groups
 596                          (ibuffer-current-state-list)
 597                          (not ibuffer-show-empty-filter-groups)
 598                          nodefault)
 599                         (if nodefault
 600                             (remove "Default" ibuffer-hidden-filter-groups)
 601                           ibuffer-hidden-filter-groups))
 602                    nil t))
 603
 604 ;;;###autoload
 605 (defun ibuffer-decompose-filter-group (group)
 606   "Decompose the filter group GROUP into active filters."
 607   (interactive
 608    (list (ibuffer-read-filter-group-name "Decompose filter group: " t)))
 609   (let ((data (cdr (assoc group ibuffer-filter-groups))))
 610     (setq ibuffer-filter-groups (ibuffer-delete-alist
 611                                  group ibuffer-filter-groups)
 612           ibuffer-filtering-qualifiers data))
 613   (ibuffer-update nil t))
 614
 615 ;;;###autoload
 616 (defun ibuffer-clear-filter-groups ()
 617   "Remove all filter groups."
 618   (interactive)
 619   (setq ibuffer-filter-groups nil
 620         ibuffer-hidden-filter-groups nil)
 621   (ibuffer-update nil t))
 622
 623 (defun ibuffer-current-filter-groups-with-position ()
 624   (save-excursion
 625     (goto-char (point-min))
 626     (let ((pos nil)
 627           (result nil))
 628       (while (and (not (eobp))
 629                   (setq pos (next-single-property-change
 630                              (point) 'ibuffer-filter-group-name)))
 631         (goto-char pos)
 632         (push (cons (get-text-property (point) 'ibuffer-filter-group-name)
 633                     pos)
 634               result)
 635         (goto-char (next-single-property-change
 636                     pos 'ibuffer-filter-group-name)))
 637       (nreverse result))))
 638
 639 ;;;###autoload
 640 (defun ibuffer-jump-to-filter-group (name)
 641   "Move point to the filter group whose name is NAME."
 642   (interactive
 643    (list (ibuffer-read-filter-group-name "Jump to filter group: ")))
 644   (ibuffer-aif (assoc name (ibuffer-current-filter-groups-with-position))
 645       (goto-char (cdr it))
 646     (error "No filter group with name %s" name)))
 647
 648 ;;;###autoload
 649 (defun ibuffer-kill-filter-group (name)
 650   "Kill the filter group named NAME.
 651 The group will be added to `ibuffer-filter-group-kill-ring'."
 652   (interactive (list (ibuffer-read-filter-group-name "Kill filter group: " t)))
 653   (when (equal name "Default")
 654     (error "Can't kill default filter group"))
 655   (ibuffer-aif (assoc name ibuffer-filter-groups)
 656       (progn
 657         (push (copy-tree it) ibuffer-filter-group-kill-ring)
 658         (setq ibuffer-filter-groups (ibuffer-delete-alist
 659                                      name ibuffer-filter-groups))
 660         (setq ibuffer-hidden-filter-groups
 661               (delete name ibuffer-hidden-filter-groups)))
 662     (error "No filter group with name \"%s\"" name))
 663   (ibuffer-update nil t))
 664
 665 ;;;###autoload
 666 (defun ibuffer-kill-line (&optional arg interactive-p)
 667   "Kill the filter group at point.
 668 See also `ibuffer-kill-filter-group'."
 669   (interactive "P\np")
 670   (ibuffer-aif (save-excursion
 671                  (ibuffer-forward-line 0)
 672                  (get-text-property (point) 'ibuffer-filter-group-name))
 673       (progn
 674         (ibuffer-kill-filter-group it))
 675       (funcall (if interactive-p #'call-interactively #'funcall)
 676                #'kill-line arg)))
 677
 678 (defun ibuffer-insert-filter-group-before (newgroup group)
 679   (let* ((found nil)
 680          (pos (let ((groups (mapcar #'car ibuffer-filter-groups))
 681                     (res 0))
 682                 (while groups
 683                   (if (equal (car groups) group)
 684                       (setq found t
 685                             groups nil)
 686                     (incf res)
 687                     (setq groups (cdr groups))))
 688                 res)))
 689     (cond ((not found)
 690            (setq ibuffer-filter-groups
 691                  (nconc ibuffer-filter-groups (list newgroup))))
 692           ((zerop pos)
 693            (push newgroup ibuffer-filter-groups))
 694           (t
 695            (let ((cell (nthcdr pos ibuffer-filter-groups)))
 696              (setf (cdr cell) (cons (car cell) (cdr cell)))
 697              (setf (car cell) newgroup))))))
 698
 699 ;;;###autoload
 700 (defun ibuffer-yank ()
 701   "Yank the last killed filter group before group at point."
 702   (interactive)
 703   (ibuffer-yank-filter-group
 704    (or (get-text-property (point) 'ibuffer-filter-group-name)
 705        (get-text-property (point) 'ibuffer-filter-group)
 706        (error "No filter group at point"))))
 707
 708 ;;;###autoload
 709 (defun ibuffer-yank-filter-group (name)
 710   "Yank the last killed filter group before group named NAME."
 711   (interactive (list (ibuffer-read-filter-group-name
 712                         "Yank filter group before group: ")))
 713   (unless ibuffer-filter-group-kill-ring
 714     (error "The Ibuffer filter group kill-ring is empty"))
 715   (save-excursion
 716     (ibuffer-forward-line 0)
 717     (ibuffer-insert-filter-group-before (pop ibuffer-filter-group-kill-ring)
 718                                         name))
 719   (ibuffer-update nil t))
 720
 721 ;;;###autoload
 722 (defun ibuffer-save-filter-groups (name groups)
 723   "Save all active filter groups GROUPS as NAME.
 724 They are added to `ibuffer-saved-filter-groups'.  Interactively,
 725 prompt for NAME, and use the current filters."
 726   (interactive
 727    (if (null ibuffer-filter-groups)
 728        (error "No filter groups active")
 729      (list
 730       (read-from-minibuffer "Save current filter groups as: ")
 731       ibuffer-filter-groups)))
 732   (ibuffer-aif (assoc name ibuffer-saved-filter-groups)
 733       (setcdr it groups)
 734     (push (cons name groups) ibuffer-saved-filter-groups))
 735   (ibuffer-maybe-save-stuff)
 736   (ibuffer-update-mode-name))
 737
 738 ;;;###autoload
 739 (defun ibuffer-delete-saved-filter-groups (name)
 740   "Delete saved filter groups with NAME.
 741 They are removed from `ibuffer-saved-filter-groups'."
 742   (interactive
 743    (list
 744     (if (null ibuffer-saved-filter-groups)
 745         (error "No saved filter groups")
 746       (completing-read "Delete saved filter group: "
 747                        ibuffer-saved-filter-groups nil t))))
 748   (setq ibuffer-saved-filter-groups
 749         (ibuffer-delete-alist name ibuffer-saved-filter-groups))
 750   (ibuffer-maybe-save-stuff)
 751   (ibuffer-update nil t))
 752
 753 ;;;###autoload
 754 (defun ibuffer-switch-to-saved-filter-groups (name)
 755   "Set this buffer's filter groups to saved version with NAME.
 756 The value from `ibuffer-saved-filters' is used.
 757 If prefix argument ADD is non-nil, then add the saved filters instead
 758 of replacing the current filters."
 759   (interactive
 760    (list
 761     (if (null ibuffer-saved-filter-groups)
 762         (error "No saved filters")
 763       (completing-read "Switch to saved filter group: "
 764                        ibuffer-saved-filter-groups nil t))))
 765   (setq ibuffer-filter-groups (cdr (assoc name ibuffer-saved-filter-groups))
 766         ibuffer-hidden-filter-groups nil)
 767   (ibuffer-update nil t))
 768
 769 ;;;###autoload
 770 (defun ibuffer-filter-disable ()
 771   "Disable all filters currently in effect in this buffer."
 772   (interactive)
 773   (setq ibuffer-filtering-qualifiers nil)
 774   (let ((buf (ibuffer-current-buffer)))
 775     (ibuffer-update nil t)
 776     (when buf
 777       (ibuffer-jump-to-buffer (buffer-name buf)))))
 778
 779 ;;;###autoload
 780 (defun ibuffer-pop-filter ()
 781   "Remove the top filter in this buffer."
 782   (interactive)
 783   (when (null ibuffer-filtering-qualifiers)
 784     (error "No filters in effect"))
 785   (pop ibuffer-filtering-qualifiers)
 786   (let ((buf (ibuffer-current-buffer)))
 787     (ibuffer-update nil t)
 788     (when buf
 789       (ibuffer-jump-to-buffer (buffer-name buf)))))
 790
 791 (defun ibuffer-push-filter (qualifier)
 792   "Add QUALIFIER to `ibuffer-filtering-qualifiers'."
 793   (push qualifier ibuffer-filtering-qualifiers))
 794
 795 ;;;###autoload
 796 (defun ibuffer-decompose-filter ()
 797   "Separate the top compound filter (OR, NOT, or SAVED) in this buffer.
 798
 799 This means that the topmost filter on the filtering stack, which must
 800 be a complex filter like (OR [name: foo] [mode: bar-mode]), will be
 801 turned into two separate filters [name: foo] and [mode: bar-mode]."
 802   (interactive)
 803   (when (null ibuffer-filtering-qualifiers)
 804     (error "No filters in effect"))
 805   (let ((lim (pop ibuffer-filtering-qualifiers)))
 806     (case (car lim)
 807       (or
 808        (setq ibuffer-filtering-qualifiers (append
 809                                           (cdr lim)
 810                                           ibuffer-filtering-qualifiers)))
 811       (saved
 812        (let ((data
 813               (assoc (cdr lim)
 814                      ibuffer-saved-filters)))
 815          (unless data
 816            (ibuffer-filter-disable)
 817            (error "Unknown saved filter %s" (cdr lim)))
 818          (setq ibuffer-filtering-qualifiers (append
 819                                             (cadr data)
 820                                             ibuffer-filtering-qualifiers))))
 821       (not
 822        (push (cdr lim)
 823              ibuffer-filtering-qualifiers))
 824       (t
 825        (error "Filter type %s is not compound" (car lim)))))
 826   (ibuffer-update nil t))
 827
 828 ;;;###autoload
 829 (defun ibuffer-exchange-filters ()
 830   "Exchange the top two filters on the stack in this buffer."
 831   (interactive)
 832   (when (< (length ibuffer-filtering-qualifiers)
 833            2)
 834     (error "Need two filters to exchange"))
 835   (let ((first (pop ibuffer-filtering-qualifiers))
 836         (second (pop ibuffer-filtering-qualifiers)))
 837     (push first ibuffer-filtering-qualifiers)
 838     (push second ibuffer-filtering-qualifiers))
 839   (ibuffer-update nil t))
 840
 841 ;;;###autoload
 842 (defun ibuffer-negate-filter ()
 843   "Negate the sense of the top filter in the current buffer."
 844   (interactive)
 845   (when (null ibuffer-filtering-qualifiers)
 846     (error "No filters in effect"))
 847   (let ((lim (pop ibuffer-filtering-qualifiers)))
 848     (push (if (eq (car lim) 'not)
 849               (cdr lim)
 850             (cons 'not lim))
 851           ibuffer-filtering-qualifiers))
 852   (ibuffer-update nil t))
 853
 854 ;;;###autoload
 855 (defun ibuffer-or-filter (&optional reverse)
 856   "Replace the top two filters in this buffer with their logical OR.
 857 If optional argument REVERSE is non-nil, instead break the top OR
 858 filter into parts."
 859   (interactive "P")
 860   (if reverse
 861       (progn
 862         (when (or (null ibuffer-filtering-qualifiers)
 863                   (not (eq 'or (caar ibuffer-filtering-qualifiers))))
 864           (error "Top filter is not an OR"))
 865         (let ((lim (pop ibuffer-filtering-qualifiers)))
 866           (setq ibuffer-filtering-qualifiers
 867                 (nconc (cdr lim) ibuffer-filtering-qualifiers))))
 868     (when (< (length ibuffer-filtering-qualifiers) 2)
 869       (error "Need two filters to OR"))
 870     ;; If the second filter is an OR, just add to it.
 871     (let ((first (pop ibuffer-filtering-qualifiers))
 872           (second (pop ibuffer-filtering-qualifiers)))
 873       (if (eq 'or (car second))
 874           (push (nconc (list 'or first) (cdr second))
 875                 ibuffer-filtering-qualifiers)
 876         (push (list 'or first second)
 877               ibuffer-filtering-qualifiers))))
 878   (ibuffer-update nil t))
 879
 880 (defun ibuffer-maybe-save-stuff ()
 881   (when ibuffer-save-with-custom
 882     (if (fboundp 'customize-save-variable)
 883         (progn
 884           (customize-save-variable 'ibuffer-saved-filters
 885                                    ibuffer-saved-filters)
 886           (customize-save-variable 'ibuffer-saved-filter-groups
 887                                    ibuffer-saved-filter-groups))
 888       (message "Not saved permanently: Customize not available"))))
 889
 890 ;;;###autoload
 891 (defun ibuffer-save-filters (name filters)
 892   "Save FILTERS in this buffer with name NAME in `ibuffer-saved-filters'.
 893 Interactively, prompt for NAME, and use the current filters."
 894   (interactive
 895    (if (null ibuffer-filtering-qualifiers)
 896        (error "No filters currently in effect")
 897      (list
 898       (read-from-minibuffer "Save current filters as: ")
 899       ibuffer-filtering-qualifiers)))
 900   (ibuffer-aif (assoc name ibuffer-saved-filters)
 901       (setcdr it filters)
 902     (push (list name filters) ibuffer-saved-filters))
 903   (ibuffer-maybe-save-stuff)
 904   (ibuffer-update-mode-name))
 905
 906 ;;;###autoload
 907 (defun ibuffer-delete-saved-filters (name)
 908   "Delete saved filters with NAME from `ibuffer-saved-filters'."
 909   (interactive
 910    (list
 911     (if (null ibuffer-saved-filters)
 912         (error "No saved filters")
 913       (completing-read "Delete saved filters: "
 914                        ibuffer-saved-filters nil t))))
 915   (setq ibuffer-saved-filters
 916         (ibuffer-delete-alist name ibuffer-saved-filters))
 917   (ibuffer-maybe-save-stuff)
 918   (ibuffer-update nil t))
 919
 920 ;;;###autoload
 921 (defun ibuffer-add-saved-filters (name)
 922   "Add saved filters from `ibuffer-saved-filters' to this buffer's filters."
 923   (interactive
 924    (list
 925     (if (null ibuffer-saved-filters)
 926         (error "No saved filters")
 927       (completing-read "Add saved filters: "
 928                        ibuffer-saved-filters nil t))))
 929   (push (cons 'saved name) ibuffer-filtering-qualifiers)
 930   (ibuffer-update nil t))
 931
 932 ;;;###autoload
 933 (defun ibuffer-switch-to-saved-filters (name)
 934   "Set this buffer's filters to filters with NAME from `ibuffer-saved-filters'.
 935 If prefix argument ADD is non-nil, then add the saved filters instead
 936 of replacing the current filters."
 937   (interactive
 938    (list
 939     (if (null ibuffer-saved-filters)
 940         (error "No saved filters")
 941       (completing-read "Switch to saved filters: "
 942                        ibuffer-saved-filters nil t))))
 943   (setq ibuffer-filtering-qualifiers (list (cons 'saved name)))
 944   (ibuffer-update nil t))
 945
 946 (defun ibuffer-format-filter-group-data (filter)
 947   (if (equal filter "Default")
 948       ""
 949     (concat "Filter:" (mapconcat #'ibuffer-format-qualifier
 950                                  (cdr (assq filter ibuffer-filter-groups))
 951                                  " "))))
 952
 953 (defun ibuffer-format-qualifier (qualifier)
 954   (if (eq (car-safe qualifier) 'not)
 955       (concat " [NOT" (ibuffer-format-qualifier-1 (cdr qualifier)) "]")
 956     (ibuffer-format-qualifier-1 qualifier)))
 957
 958 (defun ibuffer-format-qualifier-1 (qualifier)
 959   (case (car qualifier)
 960     (saved
 961      (concat " [filter: " (cdr qualifier) "]"))
 962     (or
 963      (concat " [OR" (mapconcat #'ibuffer-format-qualifier
 964                                (cdr qualifier) "") "]"))
 965     (t
 966      (let ((type (assq (car qualifier) ibuffer-filtering-alist)))
 967        (unless qualifier
 968          (error "Ibuffer: bad qualifier %s" qualifier))
 969        (concat " [" (cadr type) ": " (format "%s]" (cdr qualifier)))))))
 970
 971
 972 (defun ibuffer-list-buffer-modes ()
 973   "Create an alist of buffer modes currently in use.
 974 The list returned will be of the form (\"MODE-NAME\" . MODE-SYMBOL)."
 975   (let ((bufs (buffer-list))
 976         (modes)
 977         (this-mode))
 978     (while bufs
 979       (setq this-mode
 980             (with-current-buffer
 981                 (car bufs)
 982               major-mode)
 983             bufs (cdr bufs))
 984       (add-to-list
 985        'modes
 986        `(,(symbol-name this-mode) .
 987          ,this-mode)))
 988     modes))
 989
 990
 991 ;;; Extra operation definitions
 992
 993 ;;;###autoload (autoload 'ibuffer-filter-by-mode "ibuf-ext")
 994 (define-ibuffer-filter mode
 995   "Toggle current view to buffers with major mode QUALIFIER."
 996   (:description "major mode"
 997    :reader
 998    (intern
 999     (completing-read "Filter by major mode: " obarray
1000                      #'(lambda (e)
1001                          (string-match "-mode$"
1002                                        (symbol-name e)))
1003                      t
1004                      (let ((buf (ibuffer-current-buffer)))
1005                        (if (and buf (buffer-live-p buf))
1006                            (with-current-buffer buf
1007                              (symbol-name major-mode))
1008                          "")))))
1009   (eq qualifier (with-current-buffer buf major-mode)))
1010
1011 ;;;###autoload (autoload 'ibuffer-filter-by-used-mode "ibuf-ext")
1012 (define-ibuffer-filter used-mode
1013   "Toggle current view to buffers with major mode QUALIFIER.
1014 Called interactively, this function allows selection of modes
1015 currently used by buffers."
1016   (:description "major mode in use"
1017                 :reader
1018                 (intern
1019                  (completing-read "Filter by major mode: "
1020                                   (ibuffer-list-buffer-modes)
1021                                   nil
1022                                   t
1023                                   (let ((buf (ibuffer-current-buffer)))
1024                                     (if (and buf (buffer-live-p buf))
1025                                         (with-current-buffer buf
1026                                           (symbol-name major-mode))
1027                                       "")))))
1028   (eq qualifier (with-current-buffer buf major-mode)))
1029
1030 ;;;###autoload (autoload 'ibuffer-filter-by-name "ibuf-ext")
1031 (define-ibuffer-filter name
1032   "Toggle current view to buffers with name matching QUALIFIER."
1033   (:description "buffer name"
1034    :reader (read-from-minibuffer "Filter by name (regexp): "))
1035   (string-match qualifier (buffer-name buf)))
1036
1037 ;;;###autoload (autoload 'ibuffer-filter-by-filename "ibuf-ext")
1038 (define-ibuffer-filter filename
1039   "Toggle current view to buffers with filename matching QUALIFIER."
1040   (:description "filename"
1041    :reader (read-from-minibuffer "Filter by filename (regexp): "))
1042   (ibuffer-awhen (with-current-buffer buf
1043                    (or buffer-file-name
1044                        (and (boundp 'dired-directory)
1045                             (let ((dired-dir
1046                                    (if (stringp dired-directory)
1047                                        dired-directory
1048                                      (car dired-directory))))
1049                               (and dired-dir
1050                                    (expand-file-name dired-dir))))))
1051     (string-match qualifier it)))
1052
1053 ;;;###autoload (autoload 'ibuffer-filter-by-size-gt  "ibuf-ext")
1054 (define-ibuffer-filter size-gt
1055   "Toggle current view to buffers with size greater than QUALIFIER."
1056   (:description "size greater than"
1057    :reader
1058    (string-to-number (read-from-minibuffer "Filter by size greater than: ")))
1059   (> (with-current-buffer buf (buffer-size))
1060      qualifier))
1061
1062 ;;;###autoload (autoload 'ibuffer-filter-by-size-lt  "ibuf-ext")
1063 (define-ibuffer-filter size-lt
1064    "Toggle current view to buffers with size less than QUALIFIER."
1065   (:description "size less than"
1066    :reader
1067    (string-to-number (read-from-minibuffer "Filter by size less than: ")))
1068   (< (with-current-buffer buf (buffer-size))
1069      qualifier))
1070
1071 ;;;###autoload (autoload 'ibuffer-filter-by-content "ibuf-ext")
1072 (define-ibuffer-filter content
1073    "Toggle current view to buffers whose contents match QUALIFIER."
1074   (:description "content"
1075    :reader (read-from-minibuffer "Filter by content (regexp): "))
1076   (with-current-buffer buf
1077     (save-excursion
1078       (goto-char (point-min))
1079       (re-search-forward qualifier nil t))))
1080
1081 ;;;###autoload (autoload 'ibuffer-filter-by-predicate "ibuf-ext")
1082 (define-ibuffer-filter predicate
1083    "Toggle current view to buffers for which QUALIFIER returns non-nil."
1084   (:description "predicate"
1085    :reader (read-minibuffer "Filter by predicate (form): "))
1086   (with-current-buffer buf
1087     (eval qualifier)))
1088
1089 ;;; Sorting
1090
1091 ;;;###autoload
1092 (defun ibuffer-toggle-sorting-mode ()
1093   "Toggle the current sorting mode.
1094 Default sorting modes are:
1095  Recency - the last time the buffer was viewed
1096  Name - the name of the buffer
1097  Major Mode - the name of the major mode of the buffer
1098  Size - the size of the buffer"
1099   (interactive)
1100   (let ((modes (mapcar 'car ibuffer-sorting-functions-alist)))
1101     (add-to-list 'modes 'recency)
1102     (setq modes (sort modes 'string-lessp))
1103     (let ((next (or (car-safe (cdr-safe (memq ibuffer-sorting-mode modes)))
1104                     (car modes))))
1105       (setq ibuffer-sorting-mode next)
1106       (message "Sorting by %s" next)))
1107   (ibuffer-redisplay t))
1108
1109 ;;;###autoload
1110 (defun ibuffer-invert-sorting ()
1111   "Toggle whether or not sorting is in reverse order."
1112   (interactive)
1113   (setq ibuffer-sorting-reversep (not ibuffer-sorting-reversep))
1114   (message "Sorting order %s"
1115            (if ibuffer-sorting-reversep
1116                "reversed"
1117              "normal"))
1118   (ibuffer-redisplay t))
1119
1120 ;;;###autoload (autoload 'ibuffer-do-sort-by-major-mode "ibuf-ext")
1121 (define-ibuffer-sorter major-mode
1122   "Sort the buffers by major modes.
1123 Ordering is lexicographic."
1124   (:description "major mode")
1125   (string-lessp (downcase
1126                  (symbol-name (with-current-buffer
1127                                   (car a)
1128                                 major-mode)))
1129                 (downcase
1130                  (symbol-name (with-current-buffer
1131                                   (car b)
1132                                 major-mode)))))
1133
1134 ;;;###autoload (autoload 'ibuffer-do-sort-by-mode-name "ibuf-ext")
1135 (define-ibuffer-sorter mode-name
1136   "Sort the buffers by their mode name.
1137 Ordering is lexicographic."
1138   (:description "major mode name")
1139   (string-lessp (downcase
1140                   (with-current-buffer
1141                       (car a)
1142                     mode-name))
1143                 (downcase
1144                  (with-current-buffer
1145                      (car b)
1146                    mode-name))))
1147
1148 ;;;###autoload (autoload 'ibuffer-do-sort-by-alphabetic "ibuf-ext")
1149 (define-ibuffer-sorter alphabetic
1150   "Sort the buffers by their names.
1151 Ordering is lexicographic."
1152   (:description "buffer name")
1153   (string-lessp
1154    (buffer-name (car a))
1155    (buffer-name (car b))))
1156
1157 ;;;###autoload (autoload 'ibuffer-do-sort-by-size "ibuf-ext")
1158 (define-ibuffer-sorter size
1159  "Sort the buffers by their size."
1160   (:description "size")
1161   (< (with-current-buffer (car a)
1162        (buffer-size))
1163      (with-current-buffer (car b)
1164        (buffer-size))))
1165
1166 ;;; Functions to emulate bs.el
1167
1168 ;;;###autoload
1169 (defun ibuffer-bs-show ()
1170   "Emulate `bs-show' from the bs.el package."
1171   (interactive)
1172   (ibuffer t "*Ibuffer-bs*" '((filename . ".*")) nil t)
1173   (define-key (current-local-map) "a" 'ibuffer-bs-toggle-all))
1174
1175 (defun ibuffer-bs-toggle-all ()
1176   "Emulate `bs-toggle-show-all' from the bs.el package."
1177   (interactive)
1178   (if ibuffer-filtering-qualifiers
1179       (ibuffer-pop-filter)
1180     (progn (ibuffer-push-filter '(filename . ".*"))
1181            (ibuffer-update nil t))))
1182
1183 ;;; Handy functions
1184
1185 ;;;###autoload
1186 (defun ibuffer-add-to-tmp-hide (regexp)
1187   "Add REGEXP to `ibuffer-tmp-hide-regexps'.
1188 This means that buffers whose name matches REGEXP will not be shown
1189 for this Ibuffer session."
1190   (interactive
1191    (list
1192     (read-from-minibuffer "Never show buffers matching: "
1193                           (regexp-quote (buffer-name (ibuffer-current-buffer t))))))
1194   (push regexp ibuffer-tmp-hide-regexps))
1195
1196 ;;;###autoload
1197 (defun ibuffer-add-to-tmp-show (regexp)
1198   "Add REGEXP to `ibuffer-tmp-show-regexps'.
1199 This means that buffers whose name matches REGEXP will always be shown
1200 for this Ibuffer session."
1201   (interactive
1202    (list
1203     (read-from-minibuffer "Always show buffers matching: "
1204                           (regexp-quote (buffer-name (ibuffer-current-buffer t))))))
1205   (push regexp ibuffer-tmp-show-regexps))
1206
1207 ;;;###autoload
1208 (defun ibuffer-forward-next-marked (&optional count mark direction)
1209   "Move forward by COUNT marked buffers (default 1).
1210
1211 If MARK is non-nil, it should be a character denoting the type of mark
1212 to move by.  The default is `ibuffer-marked-char'.
1213
1214 If DIRECTION is non-nil, it should be an integer; negative integers
1215 mean move backwards, non-negative integers mean move forwards."
1216   (interactive "P")
1217   (unless count
1218     (setq count 1))
1219   (unless mark
1220     (setq mark ibuffer-marked-char))
1221   (unless direction
1222     (setq direction 1))
1223   ;; Skip the title
1224   (ibuffer-forward-line 0)
1225   (let ((opos (point))
1226         curmark)
1227     (ibuffer-forward-line direction)
1228     (while (not (or (= (point) opos)
1229                     (eq (setq curmark (ibuffer-current-mark))
1230                         mark)))
1231       (ibuffer-forward-line direction))
1232     (when (and (= (point) opos)
1233                (not (eq (ibuffer-current-mark) mark)))
1234       (error "No buffers with mark %c" mark))))
1235
1236 ;;;###autoload
1237 (defun ibuffer-backwards-next-marked (&optional count mark)
1238    "Move backwards by COUNT marked buffers (default 1).
1239
1240 If MARK is non-nil, it should be a character denoting the type of mark
1241 to move by.  The default is `ibuffer-marked-char'."
1242    (interactive "P")
1243    (ibuffer-forward-next-marked count mark -1))
1244
1245 ;;;###autoload
1246 (defun ibuffer-do-kill-lines ()
1247   "Hide all of the currently marked lines."
1248   (interactive)
1249   (if (= (ibuffer-count-marked-lines) 0)
1250       (message "No buffers marked; use 'm' to mark a buffer")
1251     (let ((count
1252            (ibuffer-map-marked-lines
1253             #'(lambda (buf mark)
1254                 'kill))))
1255       (message "Killed %s lines" count))))
1256
1257 ;;;###autoload
1258 (defun ibuffer-jump-to-buffer (name)
1259   "Move point to the buffer whose name is NAME.
1260
1261 If called interactively, prompt for a buffer name and go to the
1262 corresponding line in the Ibuffer buffer.  If said buffer is in a
1263 hidden group filter, open it.
1264
1265 If `ibuffer-jump-offer-only-visible-buffers' is non-nil, only offer
1266 visible buffers in the completion list.  Calling the command with
1267 a prefix argument reverses the meaning of that variable."
1268   (interactive (list
1269                 (let ((only-visible ibuffer-jump-offer-only-visible-buffers))
1270                   (when current-prefix-arg
1271                     (setq only-visible (not only-visible)))
1272                   (if only-visible
1273                       (let ((table (mapcar #'(lambda (x)
1274                                                (buffer-name (car x)))
1275                                            (ibuffer-current-state-list))))
1276                         (when (null table)
1277                           (error "No buffers!"))
1278                         (completing-read "Jump to buffer: "
1279                                          table nil t))
1280                     (read-buffer "Jump to buffer: " nil t)))))
1281   (when (not (string= "" name))
1282     (let (buf-point)
1283       ;; Blindly search for our buffer: it is very likely that it is
1284       ;; not in a hidden filter group.
1285       (ibuffer-map-lines #'(lambda (buf marks)
1286                              (when (string= (buffer-name buf) name)
1287                                (setq buf-point (point))
1288                                nil))
1289                          t nil)
1290       (when (and
1291              (null buf-point)
1292              (not (null ibuffer-hidden-filter-groups)))
1293         ;; We did not find our buffer.  It must be in a hidden filter
1294         ;; group, so go through all hidden filter groups to find it.
1295         (catch 'found
1296           (dolist (group ibuffer-hidden-filter-groups)
1297             (ibuffer-jump-to-filter-group group)
1298             (ibuffer-toggle-filter-group)
1299             (ibuffer-map-lines #'(lambda (buf marks)
1300                                    (when (string= (buffer-name buf) name)
1301                                      (setq buf-point (point))
1302                                      nil))
1303                                t group)
1304             (if buf-point
1305                 (throw 'found nil)
1306               (ibuffer-toggle-filter-group)))))
1307       (if (null buf-point)
1308           ;; Still not found even though we expanded all hidden filter
1309           ;; groups: that must be because it's hidden by predicate:
1310           ;; we won't bother trying to display it.
1311           (error "No buffer with name %s" name)
1312         (goto-char buf-point)))))
1313
1314 ;;;###autoload
1315 (defun ibuffer-diff-with-file ()
1316   "View the differences between this buffer and its associated file.
1317 This requires the external program \"diff\" to be in your `exec-path'."
1318   (interactive)
1319   (let ((buf (ibuffer-current-buffer)))
1320     (unless (buffer-live-p buf)
1321       (error "Buffer %s has been killed" buf))
1322     (diff-buffer-with-file buf)))
1323
1324 ;;;###autoload
1325 (defun ibuffer-copy-filename-as-kill (&optional arg)
1326   "Copy filenames of marked buffers into the kill ring.
1327
1328 The names are separated by a space.
1329 If a buffer has no filename, it is ignored.
1330
1331 With no prefix arg, use the filename sans its directory of each marked file.
1332 With a zero prefix arg, use the complete filename of each marked file.
1333 With \\[universal-argument], use the filename of each marked file relative
1334 to `ibuffer-default-directory' iff non-nil, otherwise `default-directory'.
1335
1336 You can then feed the file name(s) to other commands with \\[yank]."
1337   (interactive "p")
1338   (if (zerop (ibuffer-count-marked-lines))
1339       (message "No buffers marked; use 'm' to mark a buffer")
1340     (let ((ibuffer-copy-filename-as-kill-result "")
1341           (type (cond ((zerop arg)
1342                        'full)
1343                       ((= arg 4)
1344                        'relative)
1345                       (t
1346                        'name))))
1347       (ibuffer-map-marked-lines
1348        #'(lambda (buf mark)
1349            (setq ibuffer-copy-filename-as-kill-result
1350                  (concat ibuffer-copy-filename-as-kill-result
1351                          (let ((name (buffer-file-name buf)))
1352                            (if name
1353                                (case type
1354                                  (full
1355                                   name)
1356                                  (relative
1357                                   (file-relative-name
1358                                    name (or ibuffer-default-directory
1359                                             default-directory)))
1360                                  (t
1361                                   (file-name-nondirectory name)))
1362                              ""))
1363                          " "))))
1364       (kill-new ibuffer-copy-filename-as-kill-result))))
1365
1366 (defun ibuffer-mark-on-buffer (func &optional ibuffer-mark-on-buffer-mark group)
1367   (let ((count
1368          (ibuffer-map-lines
1369           #'(lambda (buf mark)
1370               (when (funcall func buf)
1371                 (ibuffer-set-mark-1 (or ibuffer-mark-on-buffer-mark
1372                                         ibuffer-marked-char))
1373                 t))
1374           nil
1375           group)))
1376     (ibuffer-redisplay t)
1377     (message "Marked %s buffers" count)))
1378
1379 ;;;###autoload
1380 (defun ibuffer-mark-by-name-regexp (regexp)
1381   "Mark all buffers whose name matches REGEXP."
1382   (interactive "sMark by name (regexp): ")
1383   (ibuffer-mark-on-buffer
1384    #'(lambda (buf)
1385        (string-match regexp (buffer-name buf)))))
1386
1387 ;;;###autoload
1388 (defun ibuffer-mark-by-mode-regexp (regexp)
1389   "Mark all buffers whose major mode matches REGEXP."
1390   (interactive "sMark by major mode (regexp): ")
1391   (ibuffer-mark-on-buffer
1392    #'(lambda (buf)
1393        (with-current-buffer buf
1394          (string-match regexp mode-name)))))
1395
1396 ;;;###autoload
1397 (defun ibuffer-mark-by-file-name-regexp (regexp)
1398   "Mark all buffers whose file name matches REGEXP."
1399   (interactive "sMark by file name (regexp): ")
1400   (ibuffer-mark-on-buffer
1401    #'(lambda (buf)
1402        (let ((name (or (buffer-file-name buf)
1403                        (with-current-buffer buf
1404                          (and
1405                           (boundp 'dired-directory)
1406                           (stringp dired-directory)
1407                           dired-directory)))))
1408          (when name
1409            (string-match regexp name))))))
1410
1411 ;;;###autoload
1412 (defun ibuffer-mark-by-mode (mode)
1413   "Mark all buffers whose major mode equals MODE."
1414   (interactive
1415    (list (intern (completing-read "Mark by major mode: " obarray
1416                                   #'(lambda (e)
1417                                       ;; kind of a hack...
1418                                       (and (fboundp e)
1419                                            (string-match "-mode$"
1420                                                          (symbol-name e))))
1421                                   t
1422                                   (let ((buf (ibuffer-current-buffer)))
1423                                     (if (and buf (buffer-live-p buf))
1424                                         (with-current-buffer buf
1425                                           (cons (symbol-name major-mode)
1426                                                 0))
1427                                       ""))))))
1428   (ibuffer-mark-on-buffer
1429    #'(lambda (buf)
1430        (with-current-buffer buf
1431          (eq major-mode mode)))))
1432
1433 ;;;###autoload
1434 (defun ibuffer-mark-modified-buffers ()
1435   "Mark all modified buffers."
1436   (interactive)
1437   (ibuffer-mark-on-buffer
1438    #'(lambda (buf) (buffer-modified-p buf))))
1439
1440 ;;;###autoload
1441 (defun ibuffer-mark-unsaved-buffers ()
1442   "Mark all modified buffers that have an associated file."
1443   (interactive)
1444   (ibuffer-mark-on-buffer
1445    #'(lambda (buf) (and (with-current-buffer buf buffer-file-name)
1446                         (buffer-modified-p buf)))))
1447
1448 ;;;###autoload
1449 (defun ibuffer-mark-dissociated-buffers ()
1450   "Mark all buffers whose associated file does not exist."
1451   (interactive)
1452   (ibuffer-mark-on-buffer
1453    #'(lambda (buf)
1454        (with-current-buffer buf
1455          (or
1456           (and buffer-file-name
1457                (not (file-exists-p buffer-file-name)))
1458           (and (eq major-mode 'dired-mode)
1459                (boundp 'dired-directory)
1460                (stringp dired-directory)
1461                (not (file-exists-p (file-name-directory dired-directory)))))))))
1462
1463 ;;;###autoload
1464 (defun ibuffer-mark-help-buffers ()
1465   "Mark buffers like *Help*, *Apropos*, *Info*."
1466   (interactive)
1467   (ibuffer-mark-on-buffer
1468    #'(lambda (buf)
1469        (with-current-buffer buf
1470          (memq major-mode ibuffer-help-buffer-modes)))))
1471
1472 ;;;###autoload
1473 (defun ibuffer-mark-compressed-file-buffers ()
1474   "Mark buffers whose associated file is compressed."
1475   (interactive)
1476   (ibuffer-mark-on-buffer
1477    #'(lambda (buf)
1478        (with-current-buffer buf
1479          (and buffer-file-name
1480               (string-match ibuffer-compressed-file-name-regexp
1481                            buffer-file-name))))))
1482
1483 ;;;###autoload
1484 (defun ibuffer-mark-old-buffers ()
1485   "Mark buffers which have not been viewed in `ibuffer-old-time' days."
1486   (interactive)
1487   (ibuffer-mark-on-buffer
1488    #'(lambda (buf)
1489        (with-current-buffer buf
1490          ;; hacked from midnight.el
1491          (when buffer-display-time
1492            (let* ((tm (current-time))
1493                   (now (+ (* (float (ash 1 16)) (car tm))
1494                           (float (cadr tm)) (* 0.0000001 (caddr tm))))
1495                   (then (+ (* (float (ash 1 16))
1496                               (car buffer-display-time))
1497                            (float (cadr buffer-display-time))
1498                            (* 0.0000001 (caddr buffer-display-time)))))
1499              (> (- now then) (* 60 60 ibuffer-old-time))))))))
1500
1501 ;;;###autoload
1502 (defun ibuffer-mark-special-buffers ()
1503   "Mark all buffers whose name begins and ends with '*'."
1504   (interactive)
1505   (ibuffer-mark-on-buffer
1506    #'(lambda (buf) (string-match "^\\*.+\\*$"
1507                                  (buffer-name buf)))))
1508
1509 ;;;###autoload
1510 (defun ibuffer-mark-read-only-buffers ()
1511   "Mark all read-only buffers."
1512   (interactive)
1513   (ibuffer-mark-on-buffer
1514    #'(lambda (buf)
1515        (with-current-buffer buf
1516          buffer-read-only))))
1517
1518 ;;;###autoload
1519 (defun ibuffer-mark-dired-buffers ()
1520   "Mark all `dired' buffers."
1521   (interactive)
1522   (ibuffer-mark-on-buffer
1523    #'(lambda (buf)
1524        (with-current-buffer buf
1525          (eq major-mode 'dired-mode)))))
1526
1527 ;;;###autoload
1528 (defun ibuffer-do-occur (regexp &optional nlines)
1529   "View lines which match REGEXP in all marked buffers.
1530 Optional argument NLINES says how many lines of context to display: it
1531 defaults to one."
1532   (interactive (occur-read-primary-args))
1533   (if (or (not (integerp nlines))
1534           (< nlines 0))
1535       (setq nlines 0))
1536   (when (zerop (ibuffer-count-marked-lines))
1537     (ibuffer-set-mark ibuffer-marked-char))
1538   (let ((ibuffer-do-occur-bufs nil))
1539     ;; Accumulate a list of marked buffers
1540     (ibuffer-map-marked-lines
1541      #'(lambda (buf mark)
1542          (push buf ibuffer-do-occur-bufs)))
1543     (occur-1 regexp nlines ibuffer-do-occur-bufs)))
1544
1545 (provide 'ibuf-ext)
1546
1547 ;;; arch-tag: 9af21953-deda-4c30-b76d-f81d9128e76d
1548 ;;; ibuf-ext.el ends here