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