lisp/ibuf-ext.el

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