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