(recentf-menu-open-all-flag): New option.
[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 ()
f215a1b4 225 (when (frame-or-buffer-changed-p 'ibuffer-auto-buffers-changed)
25d2f683
CW
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.
237With 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)))
f215a1b4 245 (frame-or-buffer-changed-p 'ibuffer-auto-buffers-changed)
25d2f683
CW
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 (mouse-set-point 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))
4e4a724c 266 (ibuffer-push-filter (cons 'mode
25d2f683
CW
267 (with-current-buffer buf
268 major-mode)))))
269 (ibuffer-update nil t))
270
365e1cfb
CW
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."
4e4a724c 282 (interactive)
365e1cfb
CW
283 (ibuffer-toggle-filter-group-1 (point)))
284
4e4a724c 285(defun ibuffer-toggle-filter-group-1 (posn)
365e1cfb
CW
286 (let ((name (get-text-property posn 'ibuffer-filter-group-name)))
287 (unless (stringp name)
288 (error "No filtering group name present"))
05276226
CW
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))
365e1cfb
CW
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.el")
25d2f683
CW
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
365e1cfb 342;;;###autoload (autoload 'ibuffer-do-shell-command-pipe-replace "ibuf-ext.el")
25d2f683
CW
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
365e1cfb 354;;;###autoload (autoload 'ibuffer-do-shell-command-file "ibuf-ext.el")
25d2f683
CW
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))))))))))
365e1cfb
CW
366
367;;;###autoload (autoload 'ibuffer-do-eval "ibuf-ext.el")
25d2f683
CW
368(define-ibuffer-op eval (form)
369 "Evaluate FORM in each of the buffers.
370Does 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
365e1cfb 377;;;###autoload (autoload 'ibuffer-do-view-and-eval "ibuf-ext.el")
25d2f683
CW
378(define-ibuffer-op view-and-eval (form)
379 "Evaluate FORM while displaying each of the marked buffers.
380To 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
365e1cfb 392;;;###autoload (autoload 'ibuffer-do-rename-uniquely "ibuf-ext.el")
25d2f683
CW
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
365e1cfb 399;;;###autoload (autoload 'ibuffer-do-revert "ibuf-ext.el")
25d2f683
CW
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
365e1cfb 408;;;###autoload (autoload 'ibuffer-do-replace-regexp "ibuf-ext.el")
25d2f683
CW
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
365e1cfb 428;;;###autoload (autoload 'ibuffer-do-query-replace "ibuf-ext.el")
25d2f683
CW
429(define-ibuffer-op query-replace (&rest args)
430 "Perform a `query-replace' in marked buffers."
431 (:interactive
193f8525 432 (query-replace-read-args "Query replace" t t)
25d2f683
CW
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
365e1cfb 444;;;###autoload (autoload 'ibuffer-do-query-replace-regexp "ibuf-ext.el")
25d2f683
CW
445(define-ibuffer-op query-replace-regexp (&rest args)
446 "Perform a `query-replace-regexp' in marked buffers."
447 (:interactive
193f8525 448 (query-replace-read-args "Query replace regexp" t t)
25d2f683
CW
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
365e1cfb 460;;;###autoload (autoload 'ibuffer-do-print "ibuf-ext.el")
25d2f683
CW
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
365e1cfb 513(defun ibuffer-generate-filter-groups (bmarklist)
05276226 514 (let ((filter-group-alist (append ibuffer-filter-groups
365e1cfb 515 (list (cons "Default" nil)))))
05276226
CW
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))
365e1cfb 520 (i 0))
05276226 521 (dolist (filtergroup filter-group-alist)
365e1cfb
CW
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)
05276226 533 (push (cons (car (nth j filter-group-alist))
365e1cfb
CW
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"))
05276226 543 (push (cons name ibuffer-filtering-qualifiers) ibuffer-filter-groups)
365e1cfb
CW
544 (ibuffer-filter-disable))
545
05276226
CW
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
b7f6c476
CW
551 (mapcar (lambda (mode)
552 (cons (format "%s" mode) `((mode . ,mode))))
553 (let ((modes
4ba16127 554 (ibuffer-remove-duplicates
2bf1ab74
JPW
555 (mapcar (lambda (buf)
556 (with-current-buffer buf major-mode))
b7f6c476
CW
557 (buffer-list)))))
558 (if ibuffer-view-ibuffer
559 modes
560 (delq 'ibuffer-mode modes)))))
05276226
CW
561 (ibuffer-update nil t))
562
365e1cfb
CW
563;;;###autoload
564(defun ibuffer-pop-filter-group ()
f189891b 565 "Remove the first filter group."
365e1cfb 566 (interactive)
05276226 567 (when (null ibuffer-filter-groups)
f189891b 568 (error "No filter groups active"))
b7f6c476
CW
569 (setq ibuffer-hidden-filter-groups
570 (delete (pop ibuffer-filter-groups)
571 ibuffer-hidden-filter-groups))
05276226
CW
572 (ibuffer-update nil t))
573
f189891b
CW
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."
2bf1ab74
JPW
586 (interactive
587 (list (ibuffer-read-filter-group-name "Decompose filter group: " t)))
f189891b
CW
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
05276226
CW
594;;;###autoload
595(defun ibuffer-clear-filter-groups ()
f189891b 596 "Remove all filter groups."
05276226 597 (interactive)
b7f6c476
CW
598 (setq ibuffer-filter-groups nil
599 ibuffer-hidden-filter-groups nil)
365e1cfb
CW
600 (ibuffer-update nil t))
601
05276226
CW
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
365e1cfb
CW
618;;;###autoload
619(defun ibuffer-jump-to-filter-group (name)
620 "Move point to the filter group whose name is NAME."
2bf1ab74
JPW
621 (interactive
622 (list (ibuffer-read-filter-group-name "Jump to filter group: ")))
f189891b
CW
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)))
365e1cfb 626
05276226
CW
627;;;###autoload
628(defun ibuffer-kill-filter-group (name)
f189891b 629 "Kill the filter group named NAME.
c56a4f1f 630The group will be added to `ibuffer-filter-group-kill-ring'."
f189891b 631 (interactive (list (ibuffer-read-filter-group-name "Kill filter group: " t)))
c56a4f1f 632 (when (equal name "Default")
f189891b 633 (error "Can't kill default filter group"))
05276226 634 (ibuffer-aif (assoc name ibuffer-filter-groups)
b7f6c476 635 (progn
c56a4f1f 636 (push (copy-tree it) ibuffer-filter-group-kill-ring)
b7f6c476
CW
637 (setq ibuffer-filter-groups (ibuffer-delete-alist
638 name ibuffer-filter-groups))
639 (setq ibuffer-hidden-filter-groups
b6cee494 640 (delete name ibuffer-hidden-filter-groups)))
05276226
CW
641 (error "No filter group with name \"%s\"" name))
642 (ibuffer-update nil t))
643
644;;;###autoload
818f3c45 645(defun ibuffer-kill-line (&optional arg interactive-p)
f189891b 646 "Kill the filter group at point.
c56a4f1f 647See also `ibuffer-kill-filter-group'."
818f3c45 648 (interactive "P\np")
05276226
CW
649 (ibuffer-aif (save-excursion
650 (ibuffer-forward-line 0)
651 (get-text-property (point) 'ibuffer-filter-group-name))
652 (progn
05276226 653 (ibuffer-kill-filter-group it))
818f3c45 654 (funcall (if interactive-p #'call-interactively #'funcall)
05276226
CW
655 #'kill-line arg)))
656
c56a4f1f 657(defun ibuffer-insert-filter-group-before (newgroup group)
4ba16127
JPW
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)
2bf1ab74
JPW
669 (setq ibuffer-filter-groups
670 (nconc ibuffer-filter-groups (list newgroup))))
4ba16127
JPW
671 ((zerop pos)
672 (push newgroup ibuffer-filter-groups))
c56a4f1f
CW
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
05276226 678;;;###autoload
c56a4f1f
CW
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."
36df86d8
JPW
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"))
05276226
CW
694 (save-excursion
695 (ibuffer-forward-line 0)
c56a4f1f
CW
696 (ibuffer-insert-filter-group-before (pop ibuffer-filter-group-kill-ring)
697 name))
05276226
CW
698 (ibuffer-update nil t))
699
700;;;###autoload
4e4a724c 701(defun ibuffer-save-filter-groups (name groups)
05276226
CW
702 "Save all active filter groups GROUPS as NAME.
703They are added to `ibuffer-saved-filter-groups'. Interactively,
704prompt 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)
fece59b8 713 (push (cons name groups) ibuffer-saved-filter-groups))
05276226
CW
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.
720They are removed from `ibuffer-saved-filter-groups'."
721 (interactive
722 (list
723 (if (null ibuffer-saved-filter-groups)
b6cee494
CW
724 (error "No saved filter groups")
725 (completing-read "Delete saved filter group: "
05276226
CW
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.
735The value from `ibuffer-saved-filters' is used.
736If prefix argument ADD is non-nil, then add the saved filters instead
737of 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))))
b7f6c476
CW
744 (setq ibuffer-filter-groups (cdr (assoc name ibuffer-saved-filter-groups))
745 ibuffer-hidden-filter-groups nil)
05276226
CW
746 (ibuffer-update nil t))
747
25d2f683
CW
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)
b8210c6e
JPW
753 (let ((buf (ibuffer-current-buffer)))
754 (ibuffer-update nil t)
755 (when buf
756 (ibuffer-jump-to-buffer (buffer-name buf)))))
25d2f683
CW
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)
b8210c6e
JPW
765 (let ((buf (ibuffer-current-buffer)))
766 (ibuffer-update nil t)
767 (when buf
768 (ibuffer-jump-to-buffer (buffer-name buf)))))
25d2f683
CW
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
778This means that the topmost filter on the filtering stack, which must
779be a complex filter like (OR [name: foo] [mode: bar-mode]), will be
780turned into two separate filters [name: foo] and [mode: bar-mode]."
781 (interactive)
782 (when (null ibuffer-filtering-qualifiers)
4e4a724c 783 (error "No filters in effect"))
25d2f683
CW
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.
836If optional argument REVERSE is non-nil, instead break the top OR
837filter 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)))
2bf1ab74
JPW
845 (setq ibuffer-filtering-qualifiers
846 (nconc (cdr lim) ibuffer-filtering-qualifiers))))
25d2f683
CW
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))
2bf1ab74
JPW
853 (push (nconc (list 'or first) (cdr second))
854 ibuffer-filtering-qualifiers)
25d2f683
CW
855 (push (list 'or first second)
856 ibuffer-filtering-qualifiers))))
857 (ibuffer-update nil t))
858
05276226 859(defun ibuffer-maybe-save-stuff ()
25d2f683
CW
860 (when ibuffer-save-with-custom
861 (if (fboundp 'customize-save-variable)
862 (progn
863 (customize-save-variable 'ibuffer-saved-filters
05276226
CW
864 ibuffer-saved-filters)
865 (customize-save-variable 'ibuffer-saved-filter-groups
866 ibuffer-saved-filter-groups))
25d2f683
CW
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'.
872Interactively, 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)
365e1cfb 881 (push (list name filters) ibuffer-saved-filters))
05276226 882 (ibuffer-maybe-save-stuff)
25d2f683
CW
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))
05276226 896 (ibuffer-maybe-save-stuff)
25d2f683
CW
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'.
914If prefix argument ADD is non-nil, then add the saved filters instead
915of 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))
c1244745
CW
924
925(defun ibuffer-format-filter-group-data (filter)
926 (if (equal filter "Default")
927 ""
0aa1b02e
JPW
928 (concat "Filter:" (mapconcat #'ibuffer-format-qualifier
929 (cdr (assq filter ibuffer-filter-groups))
930 " "))))
71296446 931
25d2f683
CW
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)))))))
71296446 949
0e1701c4
CW
950
951(defun ibuffer-list-buffer-modes ()
952 "Create an alist of buffer modes currently in use.
76f03778 953The list returned will be of the form (\"MODE-NAME\" . MODE-SYMBOL)."
0e1701c4
CW
954 (let ((bufs (buffer-list))
955 (modes)
956 (this-mode))
957 (while bufs
4e4a724c
JPW
958 (setq this-mode
959 (with-current-buffer
0e1701c4
CW
960 (car bufs)
961 major-mode)
962 bufs (cdr bufs))
4e4a724c 963 (add-to-list
0e1701c4 964 'modes
4e4a724c 965 `(,(symbol-name this-mode) .
0e1701c4 966 ,this-mode)))
4e4a724c 967 modes))
0e1701c4
CW
968
969
25d2f683
CW
970;;; Extra operation definitions
971
365e1cfb 972;;;###autoload (autoload 'ibuffer-filter-by-mode "ibuf-ext.el")
4e4a724c 973(define-ibuffer-filter mode
25d2f683
CW
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
0e1701c4 990;;;###autoload (autoload 'ibuffer-filter-by-used-mode "ibuf-ext.el")
4e4a724c 991(define-ibuffer-filter used-mode
0e1701c4
CW
992 "Toggle current view to buffers with major mode QUALIFIER.
993Called interactively, this function allows selection of modes
994currently used by buffers."
995 (:description "major mode in use"
996 :reader
4e4a724c
JPW
997 (intern
998 (completing-read "Filter by major mode: "
0e1701c4
CW
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
365e1cfb 1009;;;###autoload (autoload 'ibuffer-filter-by-name "ibuf-ext.el")
4e4a724c 1010(define-ibuffer-filter name
25d2f683
CW
1011 "Toggle current view to buffers with name matching QUALIFIER."
1012 (:description "buffer name"
365e1cfb 1013 :reader (read-from-minibuffer "Filter by name (regexp): "))
25d2f683
CW
1014 (string-match qualifier (buffer-name buf)))
1015
365e1cfb 1016;;;###autoload (autoload 'ibuffer-filter-by-filename "ibuf-ext.el")
25d2f683
CW
1017(define-ibuffer-filter filename
1018 "Toggle current view to buffers with filename matching QUALIFIER."
1019 (:description "filename"
365e1cfb 1020 :reader (read-from-minibuffer "Filter by filename (regexp): "))
a386a960
JPW
1021 (ibuffer-awhen (with-current-buffer buf
1022 (or buffer-file-name
1023 (and (boundp 'dired-directory)
39c7eb8a
JPW
1024 (if (stringp dired-directory)
1025 dired-directory
1026 (car dired-directory))
dc711054 1027 (expand-file-name dired-directory))))
25d2f683
CW
1028 (string-match qualifier it)))
1029
365e1cfb 1030;;;###autoload (autoload 'ibuffer-filter-by-size-gt "ibuf-ext.el")
4e4a724c 1031(define-ibuffer-filter size-gt
25d2f683
CW
1032 "Toggle current view to buffers with size greater than QUALIFIER."
1033 (:description "size greater than"
1034 :reader
1035 (string-to-number (read-from-minibuffer "Filter by size greater than: ")))
1036 (> (with-current-buffer buf (buffer-size))
1037 qualifier))
1038
365e1cfb 1039;;;###autoload (autoload 'ibuffer-filter-by-size-lt "ibuf-ext.el")
4e4a724c 1040(define-ibuffer-filter size-lt
25d2f683
CW
1041 "Toggle current view to buffers with size less than QUALIFIER."
1042 (:description "size less than"
1043 :reader
1044 (string-to-number (read-from-minibuffer "Filter by size less than: ")))
1045 (< (with-current-buffer buf (buffer-size))
1046 qualifier))
365e1cfb
CW
1047
1048;;;###autoload (autoload 'ibuffer-filter-by-content "ibuf-ext.el")
25d2f683
CW
1049(define-ibuffer-filter content
1050 "Toggle current view to buffers whose contents match QUALIFIER."
1051 (:description "content"
365e1cfb 1052 :reader (read-from-minibuffer "Filter by content (regexp): "))
25d2f683
CW
1053 (with-current-buffer buf
1054 (save-excursion
1055 (goto-char (point-min))
1056 (re-search-forward qualifier nil t))))
1057
365e1cfb 1058;;;###autoload (autoload 'ibuffer-filter-by-predicate "ibuf-ext.el")
25d2f683
CW
1059(define-ibuffer-filter predicate
1060 "Toggle current view to buffers for which QUALIFIER returns non-nil."
1061 (:description "predicate"
365e1cfb 1062 :reader (read-minibuffer "Filter by predicate (form): "))
25d2f683
CW
1063 (with-current-buffer buf
1064 (eval qualifier)))
1065
1066;;; Sorting
1067
1068;;;###autoload
1069(defun ibuffer-toggle-sorting-mode ()
1070 "Toggle the current sorting mode.
13e14c51 1071Default sorting modes are:
25d2f683
CW
1072 Recency - the last time the buffer was viewed
1073 Name - the name of the buffer
1074 Major Mode - the name of the major mode of the buffer
1075 Size - the size of the buffer"
1076 (interactive)
13e14c51
CW
1077 (let ((modes (mapcar 'car ibuffer-sorting-functions-alist)))
1078 (add-to-list 'modes 'recency)
1079 (setq modes (sort modes 'string-lessp))
1915493b 1080 (let ((next (or (car-safe (cdr-safe (memq ibuffer-sorting-mode modes)))
13e14c51
CW
1081 (car modes))))
1082 (setq ibuffer-sorting-mode next)
1083 (message "Sorting by %s" next)))
25d2f683
CW
1084 (ibuffer-redisplay t))
1085
1086;;;###autoload
1087(defun ibuffer-invert-sorting ()
1088 "Toggle whether or not sorting is in reverse order."
1089 (interactive)
1090 (setq ibuffer-sorting-reversep (not ibuffer-sorting-reversep))
1091 (message "Sorting order %s"
1092 (if ibuffer-sorting-reversep
1093 "reversed"
1094 "normal"))
1095 (ibuffer-redisplay t))
1096
365e1cfb 1097;;;###autoload (autoload 'ibuffer-do-sort-by-major-mode "ibuf-ext.el")
25d2f683
CW
1098(define-ibuffer-sorter major-mode
1099 "Sort the buffers by major modes.
1100Ordering is lexicographic."
1101 (:description "major mode")
1102 (string-lessp (downcase
1103 (symbol-name (with-current-buffer
1104 (car a)
1105 major-mode)))
1106 (downcase
1107 (symbol-name (with-current-buffer
1108 (car b)
1109 major-mode)))))
1110
365e1cfb 1111;;;###autoload (autoload 'ibuffer-do-sort-by-mode-name "ibuf-ext.el")
10cf9a43
CW
1112(define-ibuffer-sorter mode-name
1113 "Sort the buffers by their mode name.
1114Ordering is lexicographic."
0fcbf8d6 1115 (:description "major mode name")
10cf9a43 1116 (string-lessp (downcase
1915493b
CW
1117 (with-current-buffer
1118 (car a)
1119 mode-name))
10cf9a43 1120 (downcase
1915493b
CW
1121 (with-current-buffer
1122 (car b)
1123 mode-name))))
10cf9a43 1124
365e1cfb 1125;;;###autoload (autoload 'ibuffer-do-sort-by-alphabetic "ibuf-ext.el")
25d2f683
CW
1126(define-ibuffer-sorter alphabetic
1127 "Sort the buffers by their names.
1128Ordering is lexicographic."
1129 (:description "buffer name")
1130 (string-lessp
1131 (buffer-name (car a))
1132 (buffer-name (car b))))
1133
365e1cfb 1134;;;###autoload (autoload 'ibuffer-do-sort-by-size "ibuf-ext.el")
25d2f683
CW
1135(define-ibuffer-sorter size
1136 "Sort the buffers by their size."
1137 (:description "size")
1138 (< (with-current-buffer (car a)
1139 (buffer-size))
1140 (with-current-buffer (car b)
1141 (buffer-size))))
1142
1143;;; Functions to emulate bs.el
1144
1145;;;###autoload
1146(defun ibuffer-bs-show ()
1147 "Emulate `bs-show' from the bs.el package."
1148 (interactive)
1149 (ibuffer t "*Ibuffer-bs*" '((filename . ".*")) nil t)
1150 (define-key (current-local-map) "a" 'ibuffer-bs-toggle-all))
1151
1152(defun ibuffer-bs-toggle-all ()
1153 "Emulate `bs-toggle-show-all' from the bs.el package."
1154 (interactive)
1155 (if ibuffer-filtering-qualifiers
1156 (ibuffer-pop-filter)
1157 (progn (ibuffer-push-filter '(filename . ".*"))
1158 (ibuffer-update nil t))))
1159
1160;;; Handy functions
1161
1162;;;###autoload
1163(defun ibuffer-add-to-tmp-hide (regexp)
1164 "Add REGEXP to `ibuffer-tmp-hide-regexps'.
1165This means that buffers whose name matches REGEXP will not be shown
36a579c1 1166for this Ibuffer session."
25d2f683
CW
1167 (interactive
1168 (list
1169 (read-from-minibuffer "Never show buffers matching: "
1170 (regexp-quote (buffer-name (ibuffer-current-buffer t))))))
1171 (push regexp ibuffer-tmp-hide-regexps))
1172
1173;;;###autoload
1174(defun ibuffer-add-to-tmp-show (regexp)
1175 "Add REGEXP to `ibuffer-tmp-show-regexps'.
1176This means that buffers whose name matches REGEXP will always be shown
36a579c1 1177for this Ibuffer session."
25d2f683
CW
1178 (interactive
1179 (list
1180 (read-from-minibuffer "Always show buffers matching: "
1181 (regexp-quote (buffer-name (ibuffer-current-buffer t))))))
1182 (push regexp ibuffer-tmp-show-regexps))
1183
1184;;;###autoload
1185(defun ibuffer-forward-next-marked (&optional count mark direction)
1186 "Move forward by COUNT marked buffers (default 1).
1187
1188If MARK is non-nil, it should be a character denoting the type of mark
1189to move by. The default is `ibuffer-marked-char'.
1190
1191If DIRECTION is non-nil, it should be an integer; negative integers
1192mean move backwards, non-negative integers mean move forwards."
1193 (interactive "P")
1194 (unless count
1195 (setq count 1))
1196 (unless mark
1197 (setq mark ibuffer-marked-char))
1198 (unless direction
1199 (setq direction 1))
1200 ;; Skip the title
1201 (ibuffer-forward-line 0)
1202 (let ((opos (point))
1203 curmark)
1204 (ibuffer-forward-line direction)
1205 (while (not (or (= (point) opos)
1206 (eq (setq curmark (ibuffer-current-mark))
1207 mark)))
1208 (ibuffer-forward-line direction))
1209 (when (and (= (point) opos)
1210 (not (eq (ibuffer-current-mark) mark)))
1211 (error "No buffers with mark %c" mark))))
1212
1213;;;###autoload
1214(defun ibuffer-backwards-next-marked (&optional count mark)
1215 "Move backwards by COUNT marked buffers (default 1).
1216
1217If MARK is non-nil, it should be a character denoting the type of mark
1218to move by. The default is `ibuffer-marked-char'."
1219 (interactive "P")
1220 (ibuffer-forward-next-marked count mark -1))
1221
1222;;;###autoload
1223(defun ibuffer-do-kill-lines ()
1224 "Hide all of the currently marked lines."
1225 (interactive)
1226 (if (= (ibuffer-count-marked-lines) 0)
1227 (message "No buffers marked; use 'm' to mark a buffer")
1228 (let ((count
1229 (ibuffer-map-marked-lines
bde57911 1230 #'(lambda (buf mark)
25d2f683
CW
1231 'kill))))
1232 (message "Killed %s lines" count))))
1233
1234;;;###autoload
1235(defun ibuffer-jump-to-buffer (name)
0bdd7ae4
JPW
1236 "Move point to the buffer whose name is NAME.
1237
1238If called interactively, prompt for a buffer name and go to the
1239corresponding line in the Ibuffer buffer. If said buffer is in a
1240hidden group filter, open it.
1241
1242If `ibuffer-jump-offer-only-visible-buffers' is non-nil, only offer
1243visible buffers in the completion list. Calling the command with
1244a prefix argument reverses the meaning of that variable."
33a584e6
JPW
1245 (interactive (list
1246 (let ((only-visible ibuffer-jump-offer-only-visible-buffers))
1247 (when current-prefix-arg
1248 (setq only-visible (not only-visible)))
1249 (if only-visible
1250 (let ((table (mapcar #'(lambda (x)
1251 (buffer-name (car x)))
1252 (ibuffer-current-state-list))))
1253 (when (null table)
1254 (error "No buffers!"))
1255 (completing-read "Jump to buffer: "
1256 table nil t))
1257 (read-buffer "Jump to buffer: " nil t)))))
1258 (when (not (string= "" name))
1259 (let (buf-point)
1260 ;; Blindly search for our buffer: it is very likely that it is
1261 ;; not in a hidden filter group.
1262 (ibuffer-map-lines #'(lambda (buf marks)
1263 (when (string= (buffer-name buf) name)
1264 (setq buf-point (point))
1265 nil))
1266 t nil)
1267 (when (and
1268 (null buf-point)
1269 (not (null ibuffer-hidden-filter-groups)))
1270 ;; We did not find our buffer. It must be in a hidden filter
1271 ;; group, so go through all hidden filter groups to find it.
1272 (catch 'found
1273 (dolist (group ibuffer-hidden-filter-groups)
1274 (ibuffer-jump-to-filter-group group)
1275 (ibuffer-toggle-filter-group)
1276 (ibuffer-map-lines #'(lambda (buf marks)
1277 (when (string= (buffer-name buf) name)
1278 (setq buf-point (point))
1279 nil))
1280 t group)
1281 (if buf-point
1282 (throw 'found nil)
1283 (ibuffer-toggle-filter-group)))))
1284 (if (null buf-point)
1285 ;; Still not found even though we expanded all hidden filter
1286 ;; groups: that must be because it's hidden by predicate:
1287 ;; we won't bother trying to display it.
1288 (error "No buffer with name %s" name)
1289 (goto-char buf-point)))))
25d2f683
CW
1290
1291;;;###autoload
1292(defun ibuffer-diff-with-file ()
1293 "View the differences between this buffer and its associated file.
1294This requires the external program \"diff\" to be in your `exec-path'."
1295 (interactive)
125c1081 1296 (let ((buf (ibuffer-current-buffer)))
25d2f683
CW
1297 (unless (buffer-live-p buf)
1298 (error "Buffer %s has been killed" buf))
125c1081 1299 (diff-buffer-with-file buf)))
25d2f683
CW
1300
1301;;;###autoload
1302(defun ibuffer-copy-filename-as-kill (&optional arg)
1303 "Copy filenames of marked buffers into the kill ring.
4e4a724c 1304
25d2f683
CW
1305The names are separated by a space.
1306If a buffer has no filename, it is ignored.
25d2f683 1307
4e4a724c
JPW
1308With no prefix arg, use the filename sans its directory of each marked file.
1309With a zero prefix arg, use the complete filename of each marked file.
1310With \\[universal-argument], use the filename of each marked file relative
1311to `ibuffer-default-directory' iff non-nil, otherwise `default-directory'.
25d2f683 1312
4e4a724c
JPW
1313You can then feed the file name(s) to other commands with \\[yank]."
1314 (interactive "p")
1315 (if (zerop (ibuffer-count-marked-lines))
25d2f683
CW
1316 (message "No buffers marked; use 'm' to mark a buffer")
1317 (let ((ibuffer-copy-filename-as-kill-result "")
4e4a724c 1318 (type (cond ((zerop arg)
25d2f683 1319 'full)
4e4a724c
JPW
1320 ((= arg 4)
1321 'relative)
25d2f683
CW
1322 (t
1323 'name))))
1324 (ibuffer-map-marked-lines
bde57911 1325 #'(lambda (buf mark)
25d2f683
CW
1326 (setq ibuffer-copy-filename-as-kill-result
1327 (concat ibuffer-copy-filename-as-kill-result
1328 (let ((name (buffer-file-name buf)))
1329 (if name
1330 (case type
1331 (full
1332 name)
4e4a724c
JPW
1333 (relative
1334 (file-relative-name
1335 name (or ibuffer-default-directory
1336 default-directory)))
25d2f683
CW
1337 (t
1338 (file-name-nondirectory name)))
1339 ""))
1340 " "))))
4e4a724c 1341 (kill-new ibuffer-copy-filename-as-kill-result))))
25d2f683 1342
05276226 1343(defun ibuffer-mark-on-buffer (func &optional ibuffer-mark-on-buffer-mark group)
25d2f683
CW
1344 (let ((count
1345 (ibuffer-map-lines
bde57911 1346 #'(lambda (buf mark)
25d2f683 1347 (when (funcall func buf)
05276226
CW
1348 (ibuffer-set-mark-1 (or ibuffer-mark-on-buffer-mark
1349 ibuffer-marked-char))
1350 t))
1351 nil
1352 group)))
25d2f683
CW
1353 (ibuffer-redisplay t)
1354 (message "Marked %s buffers" count)))
1355
1356;;;###autoload
1357(defun ibuffer-mark-by-name-regexp (regexp)
1358 "Mark all buffers whose name matches REGEXP."
1359 (interactive "sMark by name (regexp): ")
1360 (ibuffer-mark-on-buffer
1361 #'(lambda (buf)
1362 (string-match regexp (buffer-name buf)))))
1363
1364;;;###autoload
1365(defun ibuffer-mark-by-mode-regexp (regexp)
1366 "Mark all buffers whose major mode matches REGEXP."
1367 (interactive "sMark by major mode (regexp): ")
1368 (ibuffer-mark-on-buffer
1369 #'(lambda (buf)
1370 (with-current-buffer buf
1371 (string-match regexp mode-name)))))
1372
1373;;;###autoload
1374(defun ibuffer-mark-by-file-name-regexp (regexp)
1375 "Mark all buffers whose file name matches REGEXP."
1376 (interactive "sMark by file name (regexp): ")
1377 (ibuffer-mark-on-buffer
1378 #'(lambda (buf)
1379 (let ((name (or (buffer-file-name buf)
1380 (with-current-buffer buf
1381 (and
1382 (boundp 'dired-directory)
1383 (stringp dired-directory)
1384 dired-directory)))))
1385 (when name
1386 (string-match regexp name))))))
1387
1388;;;###autoload
1389(defun ibuffer-mark-by-mode (mode)
1390 "Mark all buffers whose major mode equals MODE."
1391 (interactive
1392 (list (intern (completing-read "Mark by major mode: " obarray
1393 #'(lambda (e)
1394 ;; kind of a hack...
1395 (and (fboundp e)
1396 (string-match "-mode$"
1397 (symbol-name e))))
1398 t
1399 (let ((buf (ibuffer-current-buffer)))
1400 (if (and buf (buffer-live-p buf))
1401 (with-current-buffer buf
1402 (cons (symbol-name major-mode)
1403 0))
1404 ""))))))
1405 (ibuffer-mark-on-buffer
1406 #'(lambda (buf)
1407 (with-current-buffer buf
1408 (eq major-mode mode)))))
1409
1410;;;###autoload
1411(defun ibuffer-mark-modified-buffers ()
1412 "Mark all modified buffers."
1413 (interactive)
1414 (ibuffer-mark-on-buffer
1415 #'(lambda (buf) (buffer-modified-p buf))))
1416
1417;;;###autoload
1418(defun ibuffer-mark-unsaved-buffers ()
1419 "Mark all modified buffers that have an associated file."
1420 (interactive)
1421 (ibuffer-mark-on-buffer
1422 #'(lambda (buf) (and (with-current-buffer buf buffer-file-name)
1423 (buffer-modified-p buf)))))
1424
1425;;;###autoload
1426(defun ibuffer-mark-dissociated-buffers ()
1427 "Mark all buffers whose associated file does not exist."
1428 (interactive)
1429 (ibuffer-mark-on-buffer
1430 #'(lambda (buf)
1431 (with-current-buffer buf
1432 (or
1433 (and buffer-file-name
1434 (not (file-exists-p buffer-file-name)))
1435 (and (eq major-mode 'dired-mode)
1436 (boundp 'dired-directory)
1437 (stringp dired-directory)
1438 (not (file-exists-p (file-name-directory dired-directory)))))))))
1439
1440;;;###autoload
1441(defun ibuffer-mark-help-buffers ()
1442 "Mark buffers like *Help*, *Apropos*, *Info*."
1443 (interactive)
1444 (ibuffer-mark-on-buffer
1445 #'(lambda (buf)
1446 (with-current-buffer buf
0fcbf8d6 1447 (memq major-mode ibuffer-help-buffer-modes)))))
25d2f683
CW
1448
1449;;;###autoload
1450(defun ibuffer-mark-old-buffers ()
1451 "Mark buffers which have not been viewed in `ibuffer-old-time' days."
1452 (interactive)
1453 (ibuffer-mark-on-buffer
1454 #'(lambda (buf)
1455 (with-current-buffer buf
1456 ;; hacked from midnight.el
1457 (when buffer-display-time
1458 (let* ((tm (current-time))
1459 (now (+ (* (float (ash 1 16)) (car tm))
1460 (float (cadr tm)) (* 0.0000001 (caddr tm))))
1461 (then (+ (* (float (ash 1 16))
1462 (car buffer-display-time))
1463 (float (cadr buffer-display-time))
1464 (* 0.0000001 (caddr buffer-display-time)))))
2c1bb3d3 1465 (> (- now then) (* 60 60 ibuffer-old-time))))))))
25d2f683
CW
1466
1467;;;###autoload
1468(defun ibuffer-mark-special-buffers ()
1469 "Mark all buffers whose name begins and ends with '*'."
1470 (interactive)
1471 (ibuffer-mark-on-buffer
1472 #'(lambda (buf) (string-match "^\\*.+\\*$"
1473 (buffer-name buf)))))
1474
1475;;;###autoload
1476(defun ibuffer-mark-read-only-buffers ()
1477 "Mark all read-only buffers."
1478 (interactive)
1479 (ibuffer-mark-on-buffer
1480 #'(lambda (buf)
1481 (with-current-buffer buf
1482 buffer-read-only))))
1483
1484;;;###autoload
1485(defun ibuffer-mark-dired-buffers ()
1486 "Mark all `dired' buffers."
1487 (interactive)
1488 (ibuffer-mark-on-buffer
1489 #'(lambda (buf)
1490 (with-current-buffer buf
1491 (eq major-mode 'dired-mode)))))
1492
25d2f683
CW
1493;;;###autoload
1494(defun ibuffer-do-occur (regexp &optional nlines)
1495 "View lines which match REGEXP in all marked buffers.
1496Optional argument NLINES says how many lines of context to display: it
1497defaults to one."
365e1cfb 1498 (interactive (occur-read-primary-args))
25d2f683
CW
1499 (if (or (not (integerp nlines))
1500 (< nlines 0))
c33cdcc5 1501 (setq nlines 0))
25d2f683 1502 (when (zerop (ibuffer-count-marked-lines))
10cf9a43 1503 (ibuffer-set-mark ibuffer-marked-char))
25d2f683
CW
1504 (let ((ibuffer-do-occur-bufs nil))
1505 ;; Accumulate a list of marked buffers
1506 (ibuffer-map-marked-lines
bde57911 1507 #'(lambda (buf mark)
25d2f683 1508 (push buf ibuffer-do-occur-bufs)))
c06bd65e 1509 (occur-1 regexp nlines ibuffer-do-occur-bufs)))
25d2f683
CW
1510
1511(provide 'ibuf-ext)
1512
ab5796a9 1513;;; arch-tag: 9af21953-deda-4c30-b76d-f81d9128e76d
25d2f683 1514;;; ibuf-ext.el ends here