(vc-process-sentinel): Set mode-line-process.
[bpt/emacs.git] / lisp / ibuffer.el
CommitLineData
25d2f683
CW
1;;; ibuffer.el --- operate on buffers like dired
2
0d30b337 3;; Copyright (C) 2000, 2001, 2002, 2003, 2004,
409cc4a3 4;; 2005, 2006, 2007, 2008 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: 8 Sep 2000
25d2f683 9;; Keywords: buffer, convenience
25d2f683 10
b5cd37ea 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
b4aa6026 15;; published by the Free Software Foundation; either version 3, or (at
25d2f683
CW
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;; ibuffer.el is an advanced replacement for the `buffer-menu' which
31;; is normally distributed with Emacs. Its interface is intended to
32;; be analogous to that of Dired.
33
34;;; Code:
35
36(eval-when-compile
37 (require 'cl)
38 (require 'ibuf-macs)
39 (require 'dired))
40
730da5b2 41(require 'font-core)
fd225d80 42
735d7026
JB
43;; These come from ibuf-ext.el, which can not be require'd at compile time
44;; because it has a recursive dependency on ibuffer.el
45(defvar ibuffer-auto-mode)
46(defvar ibuffer-cached-filter-formats)
47(defvar ibuffer-compiled-filter-formats)
48(defvar ibuffer-filter-format-alist)
49(defvar ibuffer-filter-group-kill-ring)
50(defvar ibuffer-filter-groups)
51(defvar ibuffer-filtering-qualifiers)
52(defvar ibuffer-hidden-filter-groups)
53(defvar ibuffer-inline-columns)
54(defvar ibuffer-show-empty-filter-groups)
55(defvar ibuffer-tmp-hide-regexps)
56(defvar ibuffer-tmp-show-regexps)
63f0a166 57
004a00f4
DN
58(declare-function ibuffer-mark-on-buffer "ibuf-ext"
59 (func &optional ibuffer-mark-on-buffer-mark group))
60(declare-function ibuffer-format-qualifier "ibuf-ext" (qualifier))
61(declare-function ibuffer-generate-filter-groups "ibuf-ext"
62 (bmarklist &optional noempty nodefault))
63(declare-function ibuffer-format-filter-group-data "ibuf-ext" (filter))
64
25d2f683
CW
65(defgroup ibuffer nil
66 "An advanced replacement for `buffer-menu'.
67
68Ibuffer allows you to operate on buffers in a manner much like Dired.
69Operations include sorting, marking by regular expression, and
70the ability to filter the displayed buffers by various criteria."
bf247b6e 71 :version "22.1"
25d2f683
CW
72 :group 'convenience)
73
ac3c7293
JPW
74(defcustom ibuffer-formats '((mark modified read-only " " (name 18 18 :left :elide)
75 " " (size 9 -1 :right)
b9debd54 76 " " (mode 16 16 :left :elide) " " filename-and-process)
25d2f683
CW
77 (mark " " (name 16 -1) " " filename))
78 "A list of ways to display buffer lines.
79
80With Ibuffer, you are not limited to displaying just certain
81attributes of a buffer such as size, name, and mode in a particular
cba63a2d 82order. Through this variable, you can completely customize and
25d2f683
CW
83control the appearance of an Ibuffer buffer. See also
84`define-ibuffer-column', which allows you to define your own columns
85for display.
86
87This variable has the form
2e4fae7d 88 ((COLUMN COLUMN ...) (COLUMN COLUMN ...) ...)
25d2f683
CW
89Each element in `ibuffer-formats' should be a list containing COLUMN
90specifiers. A COLUMN can be any of the following:
91
92 SYMBOL - A symbol naming the column. Predefined columns are:
93 mark modified read-only name size mode process filename
94 When you define your own columns using `define-ibuffer-column', just
95 use their name like the predefined columns here. This entry can
96 also be a function of two arguments, which should return a string.
97 The first argument is the buffer object, and the second is the mark
98 on that buffer.
99 or
100 \"STRING\" - A literal string to display.
101 or
102 (SYMBOL MIN-SIZE MAX-SIZE &optional ALIGN ELIDE) - SYMBOL is a
103 symbol naming the column, and MIN-SIZE and MAX-SIZE are integers (or
104 functions of no arguments returning an integer) which constrict the
105 size of a column. If MAX-SIZE is -1, there is no upper bound. The
106 default values are 0 and -1, respectively. If MIN-SIZE is negative,
107 use the end of the string. The optional element ALIGN describes the
108 alignment of the column; it can be :left, :center or :right. The
109 optional element ELIDE describes whether or not to elide the column
110 if it is too long; valid values are :elide and nil. The default is
111 nil (don't elide).
112
113Some example of valid entries in `ibuffer-formats', with
114description (also, feel free to try them out, and experiment with your
115own!):
116
117 (mark \" \" name)
118 This format just displays the current mark (if any) and the name of
119 the buffer, separated by a space.
120 (mark modified read-only \" \" (name 16 16 :left) \" \" (size 6 -1 :right))
121 This format displays the current mark (if any), its modification and
122 read-only status, as well as the name of the buffer and its size. In
123 this format, the name is restricted to 16 characters (longer names
523304ed 124 will be truncated, and shorter names will be padded with spaces), and
cba63a2d 125 the name is also aligned to the left. The size of the buffer will
25d2f683
CW
126 be padded with spaces up to a minimum of six characters, but there is
127 no upper limit on its size. The size will also be aligned to the
128 right.
129
130Thus, if you wanted to use these two formats, add
131
132 (setq ibuffer-formats '((mark \" \" name)
133 (mark modified read-only
134 (name 16 16 :left) (size 6 -1 :right))))
135
136to your ~/.emacs file.
137
138Using \\[ibuffer-switch-format], you can rotate the display between
139the specified formats in the list."
140 :type '(repeat sexp)
141 :group 'ibuffer)
142
143(defcustom ibuffer-always-compile-formats (featurep 'bytecomp)
144 "If non-nil, then use the byte-compiler to optimize `ibuffer-formats'.
145This will increase the redisplay speed, at the cost of loading the
146elisp byte-compiler."
147 :type 'boolean
148 :group 'ibuffer)
149
150(defcustom ibuffer-fontification-alist
40c10465 151 `((10 buffer-read-only font-lock-constant-face)
9fe14abe
JPW
152 (15 (and buffer-file-name
153 (string-match ibuffer-compressed-file-name-regexp
154 buffer-file-name))
155 font-lock-doc-face)
156 (20 (string-match "^*" (buffer-name)) font-lock-keyword-face)
157 (25 (and (string-match "^ " (buffer-name))
da337a28
JPW
158 (null buffer-file-name))
159 italic)
9fe14abe
JPW
160 (30 (memq major-mode ibuffer-help-buffer-modes) font-lock-comment-face)
161 (35 (eq major-mode 'dired-mode) font-lock-function-name-face))
25d2f683
CW
162 "An alist describing how to fontify buffers.
163Each element should be of the form (PRIORITY FORM FACE), where
164PRIORITY is an integer, FORM is an arbitrary form to evaluate in the
165buffer, and FACE is the face to use for fontification. If the FORM
166evaluates to non-nil, then FACE will be put on the buffer name. The
fd225d80
CW
167element with the highest PRIORITY takes precedence.
168
4e4a724c 169If you change this variable, you must kill the Ibuffer buffer and
fd225d80 170recreate it for the change to take effect."
25d2f683
CW
171 :type '(repeat
172 (list (integer :tag "Priority")
173 (sexp :tag "Test Form")
174 face))
175 :group 'ibuffer)
176
177(defcustom ibuffer-use-other-window nil
7ad5b902 178 "If non-nil, display Ibuffer in another window by default."
25d2f683
CW
179 :type 'boolean
180 :group 'ibuffer)
181
182(defcustom ibuffer-default-shrink-to-minimum-size nil
183 "If non-nil, minimize the size of the Ibuffer window by default."
184 :type 'boolean
185 :group 'ibuffer)
186(defvar ibuffer-shrink-to-minimum-size nil)
187
0740098c
JPW
188(defcustom ibuffer-display-summary t
189 "If non-nil, summarize Ibuffer columns."
190 :type 'boolean
191 :group 'ibuffer)
192
3eda3649
CW
193(defcustom ibuffer-truncate-lines t
194 "If non-nil, do not display continuation lines."
195 :type 'boolean
196 :group 'ibuffer)
197
25d2f683
CW
198(defcustom ibuffer-case-fold-search case-fold-search
199 "If non-nil, ignore case when searching."
200 :type 'boolean
201 :group 'ibuffer)
202
203(defcustom ibuffer-default-sorting-mode 'recency
204 "The criteria by which to sort the buffers.
205
4e4a724c
JPW
206Note that this variable is local to each Ibuffer buffer. Thus, you
207can have multiple Ibuffer buffers open, each with a different sorted
25d2f683
CW
208view of the buffers."
209 :type '(choice (const :tag "Last view time" :value recency)
210 (const :tag "Lexicographic" :value alphabetic)
211 (const :tag "Buffer size" :value size)
212 (const :tag "Major mode" :value major-mode))
213 :group 'ibuffer)
214(defvar ibuffer-sorting-mode nil)
215
216(defcustom ibuffer-default-sorting-reversep nil
217 "If non-nil, reverse the default sorting order."
218 :type 'boolean
219 :group 'ibuffer)
220(defvar ibuffer-sorting-reversep nil)
221
222(defcustom ibuffer-elide-long-columns nil
972b8f82 223 "If non-nil, then elide column entries which exceed their max length."
25d2f683
CW
224 :type 'boolean
225 :group 'ibuffer)
972b8f82
JB
226(make-obsolete-variable 'ibuffer-elide-long-columns
227 "use the :elide argument of `ibuffer-formats'."
228 "22.1")
25d2f683
CW
229
230(defcustom ibuffer-eliding-string "..."
231 "The string to use for eliding long columns."
232 :type 'string
233 :group 'ibuffer)
234
235(defcustom ibuffer-maybe-show-predicates `(,(lambda (buf)
236 (and (string-match "^ " (buffer-name buf))
237 (null buffer-file-name))))
4e4a724c
JPW
238 "A list of predicates for buffers to display conditionally.
239
240A predicate can be a regexp or a function.
25d2f683
CW
241If a regexp, then it will be matched against the buffer's name.
242If a function, it will be called with the buffer as an argument, and
243should return non-nil if this buffer should be shown.
244
957237cb 245Viewing of buffers hidden because of these predicates may be customized
bf247b6e 246via `ibuffer-default-display-maybe-show-predicates' and is toggled by
957237cb
JPW
247giving a non-nil prefix argument to `ibuffer-update'.
248Note that this specialized filtering occurs before real filtering."
25d2f683
CW
249 :type '(repeat (choice regexp function))
250 :group 'ibuffer)
251
957237cb
JPW
252(defcustom ibuffer-default-display-maybe-show-predicates nil
253 "Non-nil means show buffers that match `ibuffer-maybe-show-predicates'."
254 :type 'boolean
255 :group 'ibuffer)
256
257(defvar ibuffer-display-maybe-show-predicates nil)
258
25d2f683
CW
259(defvar ibuffer-current-format nil)
260
0ce780e1
CW
261(defcustom ibuffer-movement-cycle t
262 "If non-nil, then forward and backwards movement commands cycle."
263 :type 'boolean
264 :group 'ibuffer)
265
25d2f683
CW
266(defcustom ibuffer-modified-char ?*
267 "The character to display for modified buffers."
268 :type 'character
269 :group 'ibuffer)
270
271(defcustom ibuffer-read-only-char ?%
272 "The character to display for read-only buffers."
273 :type 'character
274 :group 'ibuffer)
275
276(defcustom ibuffer-marked-char ?>
277 "The character to display for marked buffers."
278 :type 'character
279 :group 'ibuffer)
280
281(defcustom ibuffer-deletion-char ?D
282 "The character to display for buffers marked for deletion."
283 :type 'character
284 :group 'ibuffer)
285
286(defcustom ibuffer-expert nil
287 "If non-nil, don't ask for confirmation of \"dangerous\" operations."
288 :type 'boolean
289 :group 'ibuffer)
290
291(defcustom ibuffer-view-ibuffer nil
292 "If non-nil, display the current Ibuffer buffer itself.
293Note that this has a drawback - the data about the current Ibuffer
294buffer will most likely be inaccurate. This includes modification
295state, size, etc."
296 :type 'boolean
297 :group 'ibuffer)
298
299(defcustom ibuffer-always-show-last-buffer nil
4e4a724c
JPW
300 "If non-nil, always display the previous buffer.
301This variable takes precedence over filtering, and even
25d2f683
CW
302`ibuffer-never-show-predicates'."
303 :type '(choice (const :tag "Always" :value t)
304 (const :tag "Never" :value nil)
305 (const :tag "Always except minibuffer" :value :nomini))
306 :group 'ibuffer)
307
0bdd7ae4
JPW
308(defcustom ibuffer-jump-offer-only-visible-buffers nil
309 "If non-nil, only offer buffers visible in the Ibuffer buffer
310in completion lists of the `ibuffer-jump-to-buffer' command."
311 :type 'boolean
312 :group 'ibuffer)
313
25d2f683 314(defcustom ibuffer-use-header-line (boundp 'header-line-format)
7ad5b902 315 "If non-nil, display a header line containing current filters."
25d2f683
CW
316 :type 'boolean
317 :group 'ibuffer)
318
319(defcustom ibuffer-default-directory nil
4e4a724c 320 "The default directory to use for a new Ibuffer buffer.
2e4fae7d 321If nil, inherit the directory of the buffer in which `ibuffer' was
25d2f683
CW
322called. Otherwise, this variable should be a string naming a
323directory, like `default-directory'."
324 :type '(choice (const :tag "Inherit" :value nil)
325 string)
326 :group 'ibuffer)
327
4e4a724c
JPW
328(defcustom ibuffer-help-buffer-modes
329 '(help-mode apropos-mode Info-mode Info-edit-mode)
60356fb5
CW
330 "List of \"Help\" major modes."
331 :type '(repeat function)
332 :group 'ibuffer)
333
9fe14abe 334(defcustom ibuffer-compressed-file-name-regexp
fe99056f 335 "\\.\\(arj\\|bgz\\|bz2\\|gz\\|lzh\\|taz\\|tgz\\|zip\\|z\\)$"
9fe14abe
JPW
336 "Regexp to match compressed file names."
337 :type 'regexp
c7f5c0a8 338 :group 'ibuffer)
9fe14abe 339
e9e96ba0 340(defcustom ibuffer-hook nil
4e4a724c 341 "Hook run when `ibuffer' is called."
25d2f683
CW
342 :type 'hook
343 :group 'ibuffer)
972b8f82
JB
344(define-obsolete-variable-alias 'ibuffer-hooks
345 'ibuffer-hook "22.1")
25d2f683 346
e9e96ba0 347(defcustom ibuffer-mode-hook nil
4e4a724c 348 "Hook run upon entry into `ibuffer-mode'."
25d2f683
CW
349 :type 'hook
350 :group 'ibuffer)
972b8f82
JB
351(define-obsolete-variable-alias 'ibuffer-mode-hooks
352 'ibuffer-mode-hook "22.1")
25d2f683 353
4e4a724c
JPW
354(defcustom ibuffer-load-hook nil
355 "Hook run when Ibuffer is loaded."
356 :type 'hook
357 :group 'ibuffer)
358
25d2f683
CW
359(defcustom ibuffer-marked-face 'font-lock-warning-face
360 "Face used for displaying marked buffers."
361 :type 'face
362 :group 'ibuffer)
363
364(defcustom ibuffer-deletion-face 'font-lock-type-face
365 "Face used for displaying buffers marked for deletion."
366 :type 'face
367 :group 'ibuffer)
368
369(defcustom ibuffer-title-face 'font-lock-type-face
370 "Face used for the title string."
371 :type 'face
372 :group 'ibuffer)
373
b5cd37ea
CW
374(defcustom ibuffer-filter-group-name-face 'bold
375 "Face used for displaying filtering group names."
376 :type 'face
377 :group 'ibuffer)
378
25d2f683
CW
379(defcustom ibuffer-directory-abbrev-alist nil
380 "An alist of file name abbreviations like `directory-abbrev-alist'."
381 :type '(repeat (cons :format "%v"
382 :value ("" . "")
383 (regexp :tag "From")
384 (regexp :tag "To")))
385 :group 'ibuffer)
386
4e4a724c 387
25d2f683
CW
388(defvar ibuffer-mode-map nil)
389(defvar ibuffer-mode-operate-map nil)
b5e80d1a 390(defvar ibuffer-mode-groups-popup nil)
25d2f683
CW
391(unless ibuffer-mode-map
392 (let ((map (make-sparse-keymap))
b5e80d1a
CW
393 (operate-map (make-sparse-keymap "Operate"))
394 (groups-map (make-sparse-keymap "Filter Groups")))
25d2f683
CW
395 (define-key map (kbd "0") 'digit-argument)
396 (define-key map (kbd "1") 'digit-argument)
397 (define-key map (kbd "2") 'digit-argument)
398 (define-key map (kbd "3") 'digit-argument)
399 (define-key map (kbd "4") 'digit-argument)
400 (define-key map (kbd "5") 'digit-argument)
401 (define-key map (kbd "6") 'digit-argument)
402 (define-key map (kbd "7") 'digit-argument)
403 (define-key map (kbd "8") 'digit-argument)
404 (define-key map (kbd "9") 'digit-argument)
405
406 (define-key map (kbd "m") 'ibuffer-mark-forward)
407 (define-key map (kbd "t") 'ibuffer-toggle-marks)
408 (define-key map (kbd "u") 'ibuffer-unmark-forward)
409 (define-key map (kbd "=") 'ibuffer-diff-with-file)
410 (define-key map (kbd "j") 'ibuffer-jump-to-buffer)
0bdd7ae4 411 (define-key map (kbd "M-g") 'ibuffer-jump-to-buffer)
25d2f683
CW
412 (define-key map (kbd "DEL") 'ibuffer-unmark-backward)
413 (define-key map (kbd "M-DEL") 'ibuffer-unmark-all)
414 (define-key map (kbd "* *") 'ibuffer-unmark-all)
415 (define-key map (kbd "* M") 'ibuffer-mark-by-mode)
416 (define-key map (kbd "* m") 'ibuffer-mark-modified-buffers)
417 (define-key map (kbd "* u") 'ibuffer-mark-unsaved-buffers)
418 (define-key map (kbd "* s") 'ibuffer-mark-special-buffers)
419 (define-key map (kbd "* r") 'ibuffer-mark-read-only-buffers)
420 (define-key map (kbd "* /") 'ibuffer-mark-dired-buffers)
421 (define-key map (kbd "* e") 'ibuffer-mark-dissociated-buffers)
422 (define-key map (kbd "* h") 'ibuffer-mark-help-buffers)
9fe14abe 423 (define-key map (kbd "* z") 'ibuffer-mark-compressed-file-buffers)
25d2f683 424 (define-key map (kbd ".") 'ibuffer-mark-old-buffers)
71296446 425
25d2f683
CW
426 (define-key map (kbd "d") 'ibuffer-mark-for-delete)
427 (define-key map (kbd "C-d") 'ibuffer-mark-for-delete-backwards)
428 (define-key map (kbd "k") 'ibuffer-mark-for-delete)
429 (define-key map (kbd "x") 'ibuffer-do-kill-on-deletion-marks)
71296446 430
25d2f683
CW
431 ;; immediate operations
432 (define-key map (kbd "n") 'ibuffer-forward-line)
b5cd37ea 433 (define-key map (kbd "<down>") 'ibuffer-forward-line)
25d2f683
CW
434 (define-key map (kbd "SPC") 'forward-line)
435 (define-key map (kbd "p") 'ibuffer-backward-line)
cba63a2d 436 (define-key map (kbd "<up>") 'ibuffer-backward-line)
25d2f683
CW
437 (define-key map (kbd "M-}") 'ibuffer-forward-next-marked)
438 (define-key map (kbd "M-{") 'ibuffer-backwards-next-marked)
439 (define-key map (kbd "l") 'ibuffer-redisplay)
440 (define-key map (kbd "g") 'ibuffer-update)
441 (define-key map "`" 'ibuffer-switch-format)
442 (define-key map "-" 'ibuffer-add-to-tmp-hide)
443 (define-key map "+" 'ibuffer-add-to-tmp-show)
444 (define-key map "b" 'ibuffer-bury-buffer)
445 (define-key map (kbd ",") 'ibuffer-toggle-sorting-mode)
446 (define-key map (kbd "s i") 'ibuffer-invert-sorting)
447 (define-key map (kbd "s a") 'ibuffer-do-sort-by-alphabetic)
448 (define-key map (kbd "s v") 'ibuffer-do-sort-by-recency)
449 (define-key map (kbd "s s") 'ibuffer-do-sort-by-size)
450 (define-key map (kbd "s m") 'ibuffer-do-sort-by-major-mode)
451
452 (define-key map (kbd "/ m") 'ibuffer-filter-by-mode)
5bc06df9 453 (define-key map (kbd "/ M") 'ibuffer-filter-by-used-mode)
25d2f683
CW
454 (define-key map (kbd "/ n") 'ibuffer-filter-by-name)
455 (define-key map (kbd "/ c") 'ibuffer-filter-by-content)
456 (define-key map (kbd "/ e") 'ibuffer-filter-by-predicate)
457 (define-key map (kbd "/ f") 'ibuffer-filter-by-filename)
458 (define-key map (kbd "/ >") 'ibuffer-filter-by-size-gt)
459 (define-key map (kbd "/ <") 'ibuffer-filter-by-size-lt)
460 (define-key map (kbd "/ r") 'ibuffer-switch-to-saved-filters)
461 (define-key map (kbd "/ a") 'ibuffer-add-saved-filters)
462 (define-key map (kbd "/ x") 'ibuffer-delete-saved-filters)
463 (define-key map (kbd "/ d") 'ibuffer-decompose-filter)
464 (define-key map (kbd "/ s") 'ibuffer-save-filters)
465 (define-key map (kbd "/ p") 'ibuffer-pop-filter)
466 (define-key map (kbd "/ !") 'ibuffer-negate-filter)
467 (define-key map (kbd "/ t") 'ibuffer-exchange-filters)
468 (define-key map (kbd "/ TAB") 'ibuffer-exchange-filters)
469 (define-key map (kbd "/ o") 'ibuffer-or-filter)
b5cd37ea
CW
470 (define-key map (kbd "/ g") 'ibuffer-filters-to-filter-group)
471 (define-key map (kbd "/ P") 'ibuffer-pop-filter-group)
2bd26a6f 472 (define-key map (kbd "/ D") 'ibuffer-decompose-filter-group)
25d2f683 473 (define-key map (kbd "/ /") 'ibuffer-filter-disable)
b5cd37ea
CW
474
475 (define-key map (kbd "M-n") 'ibuffer-forward-filter-group)
476 (define-key map (kbd "<right>") 'ibuffer-forward-filter-group)
477 (define-key map (kbd "M-p") 'ibuffer-backward-filter-group)
478 (define-key map (kbd "<left>") 'ibuffer-backward-filter-group)
479 (define-key map (kbd "M-j") 'ibuffer-jump-to-filter-group)
cba63a2d
CW
480 (define-key map (kbd "C-k") 'ibuffer-kill-line)
481 (define-key map (kbd "C-y") 'ibuffer-yank)
482 (define-key map (kbd "/ S") 'ibuffer-save-filter-groups)
483 (define-key map (kbd "/ R") 'ibuffer-switch-to-saved-filter-groups)
484 (define-key map (kbd "/ X") 'ibuffer-delete-saved-filter-groups)
485 (define-key map (kbd "/ \\") 'ibuffer-clear-filter-groups)
71296446 486
25d2f683
CW
487 (define-key map (kbd "q") 'ibuffer-quit)
488 (define-key map (kbd "h") 'describe-mode)
489 (define-key map (kbd "?") 'describe-mode)
490
491 (define-key map (kbd "% n") 'ibuffer-mark-by-name-regexp)
492 (define-key map (kbd "% m") 'ibuffer-mark-by-mode-regexp)
493 (define-key map (kbd "% f") 'ibuffer-mark-by-file-name-regexp)
71296446 494
25d2f683
CW
495 (define-key map (kbd "C-t") 'ibuffer-visit-tags-table)
496
497 (define-key map (kbd "|") 'ibuffer-do-shell-command-pipe)
498 (define-key map (kbd "!") 'ibuffer-do-shell-command-file)
499 (define-key map (kbd "~") 'ibuffer-do-toggle-modified)
500 ;; marked operations
501 (define-key map (kbd "A") 'ibuffer-do-view)
502 (define-key map (kbd "D") 'ibuffer-do-delete)
503 (define-key map (kbd "E") 'ibuffer-do-eval)
504 (define-key map (kbd "F") 'ibuffer-do-shell-command-file)
505 (define-key map (kbd "I") 'ibuffer-do-query-replace-regexp)
506 (define-key map (kbd "H") 'ibuffer-do-view-other-frame)
507 (define-key map (kbd "N") 'ibuffer-do-shell-command-pipe-replace)
508 (define-key map (kbd "M") 'ibuffer-do-toggle-modified)
509 (define-key map (kbd "O") 'ibuffer-do-occur)
510 (define-key map (kbd "P") 'ibuffer-do-print)
511 (define-key map (kbd "Q") 'ibuffer-do-query-replace)
512 (define-key map (kbd "R") 'ibuffer-do-rename-uniquely)
513 (define-key map (kbd "S") 'ibuffer-do-save)
514 (define-key map (kbd "T") 'ibuffer-do-toggle-read-only)
515 (define-key map (kbd "U") 'ibuffer-do-replace-regexp)
516 (define-key map (kbd "V") 'ibuffer-do-revert)
517 (define-key map (kbd "W") 'ibuffer-do-view-and-eval)
518 (define-key map (kbd "X") 'ibuffer-do-shell-command-pipe)
71296446 519
25d2f683
CW
520 (define-key map (kbd "k") 'ibuffer-do-kill-lines)
521 (define-key map (kbd "w") 'ibuffer-copy-filename-as-kill)
522
523 (define-key map (kbd "RET") 'ibuffer-visit-buffer)
524 (define-key map (kbd "e") 'ibuffer-visit-buffer)
525 (define-key map (kbd "f") 'ibuffer-visit-buffer)
526 (define-key map (kbd "C-x C-f") 'ibuffer-find-file)
527 (define-key map (kbd "o") 'ibuffer-visit-buffer-other-window)
528 (define-key map (kbd "C-o") 'ibuffer-visit-buffer-other-window-noselect)
529 (define-key map (kbd "M-o") 'ibuffer-visit-buffer-1-window)
530 (define-key map (kbd "v") 'ibuffer-do-view)
531 (define-key map (kbd "C-x v") 'ibuffer-do-view-horizontally)
532 (define-key map (kbd "C-c C-a") 'ibuffer-auto-mode)
533 (define-key map (kbd "C-x 4 RET") 'ibuffer-visit-buffer-other-window)
534 (define-key map (kbd "C-x 5 RET") 'ibuffer-visit-buffer-other-frame)
535
536 (define-key map [menu-bar view]
537 (cons "View" (make-sparse-keymap "View")))
538
539 (define-key-after map [menu-bar view visit-buffer]
540 '(menu-item "View this buffer" ibuffer-visit-buffer))
541 (define-key-after map [menu-bar view visit-buffer-other-window]
542 '(menu-item "View (other window)" ibuffer-visit-buffer-other-window))
543 (define-key-after map [menu-bar view visit-buffer-other-frame]
544 '(menu-item "View (other frame)" ibuffer-visit-buffer-other-frame))
545 (define-key-after map [menu-bar view ibuffer-update]
546 '(menu-item "Update" ibuffer-update
547 :help "Regenerate the list of buffers"))
548 (define-key-after map [menu-bar view switch-format]
549 '(menu-item "Switch display format" ibuffer-switch-format
550 :help "Toggle between available values of `ibuffer-formats'"))
551
552 (define-key-after map [menu-bar view dashes]
553 '("--"))
554
555 (define-key-after map [menu-bar view sort]
556 (cons "Sort" (make-sparse-keymap "Sort")))
557
558 (define-key-after map [menu-bar view sort do-sort-by-major-mode]
cba63a2d 559 '(menu-item "Sort by major mode" ibuffer-do-sort-by-major-mode))
25d2f683 560 (define-key-after map [menu-bar view sort do-sort-by-size]
cba63a2d 561 '(menu-item "Sort by buffer size" ibuffer-do-sort-by-size))
25d2f683
CW
562 (define-key-after map [menu-bar view sort do-sort-by-alphabetic]
563 '(menu-item "Sort lexicographically" ibuffer-do-sort-by-alphabetic
564 :help "Sort by the alphabetic order of buffer name"))
565 (define-key-after map [menu-bar view sort do-sort-by-recency]
566 '(menu-item "Sort by view time" ibuffer-do-sort-by-recency
567 :help "Sort by the last time the buffer was displayed"))
4e4a724c
JPW
568 (define-key-after map [menu-bar view sort dashes]
569 '("--"))
25d2f683
CW
570 (define-key-after map [menu-bar view sort invert-sorting]
571 '(menu-item "Reverse sorting order" ibuffer-invert-sorting))
572 (define-key-after map [menu-bar view sort toggle-sorting-mode]
573 '(menu-item "Switch sorting mode" ibuffer-toggle-sorting-mode
574 :help "Switch between the various sorting criteria"))
575
576 (define-key-after map [menu-bar view filter]
577 (cons "Filter" (make-sparse-keymap "Filter")))
578
579 (define-key-after map [menu-bar view filter filter-disable]
05cc03af
CW
580 '(menu-item "Disable all filtering" ibuffer-filter-disable
581 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)))
25d2f683 582 (define-key-after map [menu-bar view filter filter-by-mode]
cba63a2d 583 '(menu-item "Add filter by major mode..." ibuffer-filter-by-mode))
5bc06df9
CW
584 (define-key-after map [menu-bar view filter filter-by-mode]
585 '(menu-item "Add filter by major mode in use..." ibuffer-filter-by-used-mode))
25d2f683 586 (define-key-after map [menu-bar view filter filter-by-name]
cba63a2d 587 '(menu-item "Add filter by buffer name..." ibuffer-filter-by-name))
25d2f683 588 (define-key-after map [menu-bar view filter filter-by-filename]
cba63a2d 589 '(menu-item "Add filter by filename..." ibuffer-filter-by-filename))
25d2f683 590 (define-key-after map [menu-bar view filter filter-by-size-lt]
cba63a2d 591 '(menu-item "Add filter by size less than..." ibuffer-filter-by-size-lt))
25d2f683 592 (define-key-after map [menu-bar view filter filter-by-size-gt]
cba63a2d 593 '(menu-item "Add filter by size greater than..." ibuffer-filter-by-size-gt))
25d2f683 594 (define-key-after map [menu-bar view filter filter-by-content]
cba63a2d 595 '(menu-item "Add filter by content (regexp)..." ibuffer-filter-by-content))
25d2f683 596 (define-key-after map [menu-bar view filter filter-by-predicate]
cba63a2d 597 '(menu-item "Add filter by Lisp predicate..." ibuffer-filter-by-predicate))
25d2f683 598 (define-key-after map [menu-bar view filter pop-filter]
05cc03af
CW
599 '(menu-item "Remove top filter" ibuffer-pop-filter
600 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)))
25d2f683
CW
601 (define-key-after map [menu-bar view filter or-filter]
602 '(menu-item "OR top two filters" ibuffer-or-filter
717339e5
CW
603 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers
604 (cdr ibuffer-filtering-qualifiers))
25d2f683
CW
605 :help "Create a new filter which is the logical OR of the top two filters"))
606 (define-key-after map [menu-bar view filter negate-filter]
05cc03af
CW
607 '(menu-item "Negate top filter" ibuffer-negate-filter
608 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)))
25d2f683
CW
609 (define-key-after map [menu-bar view filter decompose-filter]
610 '(menu-item "Decompose top filter" ibuffer-decompose-filter
717339e5 611 :enable (and (featurep 'ibuf-ext) (memq (car ibuffer-filtering-qualifiers) '(or saved not)))
25d2f683
CW
612 :help "Break down a complex filter like OR or NOT"))
613 (define-key-after map [menu-bar view filter exchange-filters]
05cc03af 614 '(menu-item "Swap top two filters" ibuffer-exchange-filters
717339e5
CW
615 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers
616 (cdr ibuffer-filtering-qualifiers))))
25d2f683
CW
617 (define-key-after map [menu-bar view filter save-filters]
618 '(menu-item "Save current filters permanently..." ibuffer-save-filters
4e4a724c 619 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)
25d2f683
CW
620 :help "Use a mnemnonic name to store current filter stack"))
621 (define-key-after map [menu-bar view filter switch-to-saved-filters]
622 '(menu-item "Restore permanently saved filters..." ibuffer-switch-to-saved-filters
05cc03af 623 :enable (and (featurep 'ibuf-ext) ibuffer-saved-filters)
25d2f683
CW
624 :help "Replace current filters with a saved stack"))
625 (define-key-after map [menu-bar view filter add-saved-filters]
626 '(menu-item "Add to permanently saved filters..." ibuffer-add-saved-filters
05cc03af 627 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)
cba63a2d 628 :help "Include already saved stack with current filters"))
25d2f683 629 (define-key-after map [menu-bar view filter delete-saved-filters]
cba63a2d 630 '(menu-item "Delete permanently saved filters..."
05cc03af
CW
631 ibuffer-delete-saved-filters
632 :enable (and (featurep 'ibuf-ext) ibuffer-saved-filters)))
cba63a2d 633
b5e80d1a 634 ;; Filter groups
cba63a2d 635
b5e80d1a 636 (define-key-after groups-map [filters-to-filter-group]
cba63a2d 637 '(menu-item "Create filter group from current filters..."
2bd26a6f
CW
638 ibuffer-filters-to-filter-group
639 :enable (and (featurep 'ibuf-ext) ibuffer-filtering-qualifiers)))
b5e80d1a 640 (define-key-after groups-map [forward-filter-group]
cba63a2d 641 '(menu-item "Move point to the next filter group"
4e4a724c 642 ibuffer-forward-filter-group))
b5e80d1a 643 (define-key-after groups-map [backward-filter-group]
cba63a2d
CW
644 '(menu-item "Move point to the previous filter group"
645 ibuffer-backward-filter-group))
b5e80d1a 646 (define-key-after groups-map [jump-to-filter-group]
cba63a2d
CW
647 '(menu-item "Move point to a specific filter group..."
648 ibuffer-jump-to-filter-group))
b5e80d1a
CW
649 (define-key-after groups-map [kill-filter-group]
650 '(menu-item "Kill filter group named..."
651 ibuffer-kill-filter-group
652 :enable (and (featurep 'ibuf-ext) ibuffer-filter-groups)))
653 (define-key-after groups-map [yank-filter-group]
654 '(menu-item "Yank last killed filter group before..."
655 ibuffer-yank-filter-group
656 :enable (and (featurep 'ibuf-ext) ibuffer-filter-group-kill-ring)))
657 (define-key-after groups-map [pop-filter-group]
b5cd37ea 658 '(menu-item "Remove top filter group"
b5e80d1a 659 ibuffer-pop-filter-group
2bd26a6f 660 :enable (and (featurep 'ibuf-ext) ibuffer-filter-groups)))
b5e80d1a 661 (define-key-after groups-map [clear-filter-groups]
cba63a2d 662 '(menu-item "Remove all filter groups"
b5e80d1a 663 ibuffer-clear-filter-groups
2bd26a6f
CW
664 :enable (and (featurep 'ibuf-ext) ibuffer-filter-groups)))
665 (define-key-after groups-map [pop-filter-group]
666 '(menu-item "Decompose filter group..."
667 ibuffer-pop-filter-group
668 :help "\"Unmake\" a filter group"
669 :enable (and (featurep 'ibuf-ext) ibuffer-filter-groups)))
b5e80d1a 670 (define-key-after groups-map [save-filter-groups]
cba63a2d
CW
671 '(menu-item "Save current filter groups permanently..."
672 ibuffer-save-filter-groups
05cc03af 673 :enable (and (featurep 'ibuf-ext) ibuffer-filter-groups)
cba63a2d 674 :help "Use a mnemnonic name to store current filter groups"))
b5e80d1a 675 (define-key-after groups-map [switch-to-saved-filter-groups]
cba63a2d
CW
676 '(menu-item "Restore permanently saved filters..."
677 ibuffer-switch-to-saved-filter-groups
05cc03af 678 :enable (and (featurep 'ibuf-ext) ibuffer-saved-filter-groups)
4e4a724c 679 :help "Replace current filters with a saved stack"))
b5e80d1a 680 (define-key-after groups-map [delete-saved-filter-groups]
cba63a2d 681 '(menu-item "Delete permanently saved filter groups..."
05cc03af
CW
682 ibuffer-delete-saved-filter-groups
683 :enable (and (featurep 'ibuf-ext) ibuffer-saved-filter-groups)))
b5e80d1a 684 (define-key-after groups-map [set-filter-groups-by-mode]
cba63a2d
CW
685 '(menu-item "Set current filter groups to filter by mode"
686 ibuffer-set-filter-groups-by-mode))
687
b5e80d1a
CW
688 (define-key-after map [menu-bar view filter-groups]
689 (cons "Filter Groups" groups-map))
690
25d2f683
CW
691 (define-key-after map [menu-bar view dashes2]
692 '("--"))
693 (define-key-after map [menu-bar view diff-with-file]
694 '(menu-item "Diff with file" ibuffer-diff-with-file
695 :help "View the differences between this buffer and its file"))
696 (define-key-after map [menu-bar view auto-mode]
697 '(menu-item "Toggle Auto Mode" ibuffer-auto-mode
698 :help "Attempt to automatically update the Ibuffer buffer"))
699 (define-key-after map [menu-bar view customize]
4e4a724c 700 '(menu-item "Customize Ibuffer" ibuffer-customize
25d2f683
CW
701 :help "Use Custom to customize Ibuffer"))
702
703 (define-key-after map [menu-bar mark]
704 (cons "Mark" (make-sparse-keymap "Mark")))
705
706 (define-key-after map [menu-bar mark toggle-marks]
707 '(menu-item "Toggle marks" ibuffer-toggle-marks
708 :help "Unmark marked buffers, and mark unmarked buffers"))
709 (define-key-after map [menu-bar mark mark-forward]
710 '(menu-item "Mark" ibuffer-mark-forward
711 :help "Mark the buffer at point"))
712 (define-key-after map [menu-bar mark unmark-forward]
713 '(menu-item "Unmark" ibuffer-unmark-forward
714 :help "Unmark the buffer at point"))
715 (define-key-after map [menu-bar mark mark-by-mode]
716 '(menu-item "Mark by mode..." ibuffer-mark-by-mode
717 :help "Mark all buffers in a particular major mode"))
718 (define-key-after map [menu-bar mark mark-modified-buffers]
719 '(menu-item "Mark modified buffers" ibuffer-mark-modified-buffers
720 :help "Mark all buffers which have been modified"))
721 (define-key-after map [menu-bar mark mark-unsaved-buffers]
722 '(menu-item "Mark unsaved buffers" ibuffer-mark-unsaved-buffers
723 :help "Mark all buffers which have a file and are modified"))
724 (define-key-after map [menu-bar mark mark-read-only-buffers]
725 '(menu-item "Mark read-only buffers" ibuffer-mark-read-only-buffers
726 :help "Mark all buffers which are read-only"))
727 (define-key-after map [menu-bar mark mark-special-buffers]
728 '(menu-item "Mark special buffers" ibuffer-mark-special-buffers
729 :help "Mark all buffers whose name begins with a *"))
730 (define-key-after map [menu-bar mark mark-dired-buffers]
731 '(menu-item "Mark dired buffers" ibuffer-mark-dired-buffers
732 :help "Mark buffers in dired-mode"))
733 (define-key-after map [menu-bar mark mark-dissociated-buffers]
734 '(menu-item "Mark dissociated buffers" ibuffer-mark-dissociated-buffers
735 :help "Mark buffers with a non-existent associated file"))
736 (define-key-after map [menu-bar mark mark-help-buffers]
737 '(menu-item "Mark help buffers" ibuffer-mark-help-buffers
738 :help "Mark buffers in help-mode"))
9fe14abe
JPW
739 (define-key-after map [menu-bar mark mark-compressed-file-buffers]
740 '(menu-item "Mark compressed file buffers" ibuffer-mark-compressed-file-buffers
741 :help "Mark buffers which have a file that is compressed"))
25d2f683
CW
742 (define-key-after map [menu-bar mark mark-old-buffers]
743 '(menu-item "Mark old buffers" ibuffer-mark-old-buffers
744 :help "Mark buffers which have not been viewed recently"))
745 (define-key-after map [menu-bar mark unmark-all]
746 '(menu-item "Unmark All" ibuffer-unmark-all))
71296446 747
25d2f683
CW
748 (define-key-after map [menu-bar mark dashes]
749 '("--"))
71296446 750
25d2f683
CW
751 (define-key-after map [menu-bar mark mark-by-name-regexp]
752 '(menu-item "Mark by buffer name (regexp)..." ibuffer-mark-by-name-regexp
753 :help "Mark buffers whose name matches a regexp"))
754 (define-key-after map [menu-bar mark mark-by-mode-regexp]
755 '(menu-item "Mark by major mode (regexp)..." ibuffer-mark-by-mode-regexp
756 :help "Mark buffers whose major mode name matches a regexp"))
757 (define-key-after map [menu-bar mark mark-by-file-name-regexp]
758 '(menu-item "Mark by file name (regexp)..." ibuffer-mark-by-file-name-regexp
759 :help "Mark buffers whose file name matches a regexp"))
760
761 ;; Operate map is added later
762
763 (define-key-after operate-map [do-view]
764 '(menu-item "View" ibuffer-do-view))
765 (define-key-after operate-map [do-view-other-frame]
766 '(menu-item "View (separate frame)" ibuffer-do-view-other-frame))
767 (define-key-after operate-map [do-save]
768 '(menu-item "Save" ibuffer-do-save))
769 (define-key-after operate-map [do-replace-regexp]
770 '(menu-item "Replace (regexp)..." ibuffer-do-replace-regexp
771 :help "Replace text inside marked buffers"))
772 (define-key-after operate-map [do-query-replace]
773 '(menu-item "Query Replace..." ibuffer-do-query-replace
774 :help "Replace text in marked buffers, asking each time"))
775 (define-key-after operate-map [do-query-replace-regexp]
776 '(menu-item "Query Replace (regexp)..." ibuffer-do-query-replace-regexp
777 :help "Replace text in marked buffers by regexp, asking each time"))
778 (define-key-after operate-map [do-print]
779 '(menu-item "Print" ibuffer-do-print))
780 (define-key-after operate-map [do-toggle-modified]
781 '(menu-item "Toggle modification flag" ibuffer-do-toggle-modified))
782 (define-key-after operate-map [do-revert]
783 '(menu-item "Revert" ibuffer-do-revert
784 :help "Revert marked buffers to their associated file"))
785 (define-key-after operate-map [do-rename-uniquely]
786 '(menu-item "Rename Uniquely" ibuffer-do-rename-uniquely
787 :help "Rename marked buffers to a new, unique name"))
788 (define-key-after operate-map [do-delete]
789 '(menu-item "Kill" ibuffer-do-delete))
790 (define-key-after operate-map [do-occur]
791 '(menu-item "List lines matching..." ibuffer-do-occur
792 :help "View all lines in marked buffers matching a regexp"))
793 (define-key-after operate-map [do-shell-command-pipe]
794 '(menu-item "Pipe to shell command..." ibuffer-do-shell-command-pipe
795 :help "For each marked buffer, send its contents to a shell command"))
796 (define-key-after operate-map [do-shell-command-pipe-replace]
797 '(menu-item "Pipe to shell command (replace)..." ibuffer-do-shell-command-pipe-replace
798 :help "For each marked buffer, replace its contents with output of shell command"))
799 (define-key-after operate-map [do-shell-command-file]
800 '(menu-item "Shell command on buffer's file..." ibuffer-do-shell-command-file
801 :help "For each marked buffer, run a shell command with its file as argument"))
802 (define-key-after operate-map [do-eval]
803 '(menu-item "Eval..." ibuffer-do-eval
804 :help "Evaluate a Lisp form in each marked buffer"))
805 (define-key-after operate-map [do-view-and-eval]
806 '(menu-item "Eval (viewing buffer)..." ibuffer-do-view-and-eval
807 :help "Evaluate a Lisp form in each marked buffer while viewing it"))
71296446 808
25d2f683 809 (setq ibuffer-mode-map map
b5e80d1a 810 ibuffer-mode-operate-map operate-map
2bd26a6f
CW
811 ibuffer-mode-groups-popup (copy-keymap groups-map))))
812
813(define-key ibuffer-mode-groups-popup [kill-filter-group]
4e4a724c
JPW
814 '(menu-item "Kill filter group"
815 ibuffer-kill-line
34a4faa0
JPW
816 :enable (and (featurep 'ibuf-ext)
817 ibuffer-filter-groups)))
545aad2f 818(define-key ibuffer-mode-groups-popup [yank-filter-group]
4e4a724c
JPW
819 '(menu-item "Yank last killed filter group"
820 ibuffer-yank
34a4faa0
JPW
821 :enable (and (featurep 'ibuf-ext)
822 ibuffer-filter-group-kill-ring)))
4e4a724c 823
acf88897 824(defvar ibuffer-name-map
25d2f683 825 (let ((map (make-sparse-keymap)))
25d2f683
CW
826 (define-key map [(mouse-1)] 'ibuffer-mouse-toggle-mark)
827 (define-key map [(mouse-2)] 'ibuffer-mouse-visit-buffer)
828 (define-key map [down-mouse-3] 'ibuffer-mouse-popup-menu)
acf88897 829 map))
25d2f683 830
acf88897 831(defvar ibuffer-mode-name-map
25d2f683 832 (let ((map (make-sparse-keymap)))
25d2f683
CW
833 (define-key map [(mouse-2)] 'ibuffer-mouse-filter-by-mode)
834 (define-key map (kbd "RET") 'ibuffer-interactive-filter-by-mode)
acf88897 835 map))
25d2f683 836
f0b31589
DN
837(defvar ibuffer-name-header-map
838 (let ((map (make-sparse-keymap)))
839 (define-key map [(mouse-1)] 'ibuffer-do-sort-by-alphabetic)
840 map))
841
842(defvar ibuffer-size-header-map
843 (let ((map (make-sparse-keymap)))
844 (define-key map [(mouse-1)] 'ibuffer-do-sort-by-size)
845 map))
846
847(defvar ibuffer-mode-header-map
848 (let ((map (make-sparse-keymap)))
849 (define-key map [(mouse-1)] 'ibuffer-do-sort-by-major-mode)
850 map))
851
acf88897 852(defvar ibuffer-mode-filter-group-map
b5cd37ea 853 (let ((map (make-sparse-keymap)))
b5cd37ea
CW
854 (define-key map [(mouse-1)] 'ibuffer-mouse-toggle-mark)
855 (define-key map [(mouse-2)] 'ibuffer-mouse-toggle-filter-group)
856 (define-key map (kbd "RET") 'ibuffer-toggle-filter-group)
b5e80d1a 857 (define-key map [down-mouse-3] 'ibuffer-mouse-popup-menu)
acf88897 858 map))
b5cd37ea 859
4ed1f829
JPW
860(defvar ibuffer-restore-window-config-on-quit nil
861 "If non-nil, restore previous window configuration upon exiting `ibuffer'.")
862
863(defvar ibuffer-prev-window-config nil
864 "Window configuration before starting Ibuffer.")
25d2f683
CW
865
866(defvar ibuffer-did-modification nil)
867
63f0a166
JB
868(defvar ibuffer-compiled-formats nil)
869(defvar ibuffer-cached-formats nil)
870(defvar ibuffer-cached-eliding-string nil)
871(defvar ibuffer-cached-elide-long-columns 0)
872
25d2f683
CW
873(defvar ibuffer-sorting-functions-alist nil
874 "An alist of functions which describe how to sort buffers.
875
876Note: You most likely do not want to modify this variable directly;
877use `define-ibuffer-sorter' instead.
878
879The alist elements are constructed like (NAME DESCRIPTION FUNCTION)
880Where NAME is a symbol describing the sorting method, DESCRIPTION is a
881short string which will be displayed in the minibuffer and menu, and
882FUNCTION is a function of two arguments, which will be the buffers to
883compare.")
884
885;;; Utility functions
886(defun ibuffer-columnize-and-insert-list (list &optional pad-width)
887 "Insert LIST into the current buffer in as many columns as possible.
888The maximum number of columns is determined by the current window
889width and the longest string in LIST."
890 (unless pad-width
891 (setq pad-width 3))
892 (let ((width (window-width))
893 (max (+ (apply #'max (mapcar #'length list))
894 pad-width)))
895 (let ((columns (/ width max)))
896 (when (zerop columns)
897 (setq columns 1))
898 (while list
899 (dotimes (i (1- columns))
900 (insert (concat (car list) (make-string (- max (length (car list)))
972b8f82 901 ?\s)))
25d2f683
CW
902 (setq list (cdr list)))
903 (when (not (null list))
904 (insert (pop list)))
905 (insert "\n")))))
906
25d2f683
CW
907(defsubst ibuffer-current-mark ()
908 (cadr (get-text-property (line-beginning-position)
909 'ibuffer-properties)))
910
911(defun ibuffer-mouse-toggle-mark (event)
912 "Toggle the marked status of the buffer chosen with the mouse."
913 (interactive "e")
914 (unwind-protect
b5cd37ea
CW
915 (let ((pt (save-excursion
916 (mouse-set-point event)
917 (point))))
918 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group-name)
919 (ibuffer-toggle-marks it)
920 (goto-char pt)
921 (let ((mark (ibuffer-current-mark)))
922 (setq buffer-read-only nil)
923 (if (eq mark ibuffer-marked-char)
972b8f82 924 (ibuffer-set-mark ?\s)
b5cd37ea 925 (ibuffer-set-mark ibuffer-marked-char)))))
25d2f683
CW
926 (setq buffer-read-only t)))
927
928(defun ibuffer-find-file (file &optional wildcards)
929 "Like `find-file', but default to the directory of the buffer at point."
930 (interactive
931 (let ((default-directory (let ((buf (ibuffer-current-buffer)))
932 (if (buffer-live-p buf)
933 (with-current-buffer buf
934 default-directory)
935 default-directory))))
936 (list (read-file-name "Find file: " default-directory)
fe78af29
JPW
937 t)))
938 (find-file file wildcards))
25d2f683
CW
939
940(defun ibuffer-mouse-visit-buffer (event)
941 "Visit the buffer chosen with the mouse."
942 (interactive "e")
943 (switch-to-buffer
944 (save-excursion
945 (mouse-set-point event)
b5cd37ea 946 (ibuffer-current-buffer t))))
25d2f683
CW
947
948(defun ibuffer-mouse-popup-menu (event)
949 "Display a menu of operations."
950 (interactive "e")
a1793b2d
JPW
951 (let ((eventpt (posn-point (event-end event)))
952 (origpt (point)))
25d2f683 953 (unwind-protect
51922c04 954 (if (get-text-property eventpt 'ibuffer-filter-group-name)
a1793b2d
JPW
955 (progn
956 (goto-char eventpt)
957 (popup-menu ibuffer-mode-groups-popup))
51922c04 958 (let ((inhibit-read-only t))
b5e80d1a 959 (ibuffer-save-marks
4e4a724c
JPW
960 ;; hm. we could probably do this in a better fashion
961 (ibuffer-unmark-all ?\r)
962 (save-excursion
963 (goto-char eventpt)
964 (ibuffer-set-mark ibuffer-marked-char))
965 (save-excursion
966 (popup-menu ibuffer-mode-operate-map)))))
a1793b2d 967 (setq buffer-read-only t)
4ba16127 968 (if (= eventpt (point))
a1793b2d 969 (goto-char origpt)))))
51922c04 970
b5cd37ea
CW
971(defun ibuffer-skip-properties (props direction)
972 (while (and (not (eobp))
973 (let ((hit nil))
974 (dolist (prop props hit)
975 (when (get-text-property (point) prop)
976 (setq hit t)))))
977 (forward-line direction)
978 (beginning-of-line)))
25d2f683 979
4e4a724c
JPW
980(defun ibuffer-customize ()
981 "Begin customizing Ibuffer interactively."
982 (interactive)
983 (customize-group 'ibuffer))
984
b5cd37ea 985(defun ibuffer-backward-line (&optional arg skip-group-names)
25d2f683
CW
986 "Move backwards ARG lines, wrapping around the list if necessary."
987 (interactive "P")
34a4faa0 988 (or arg (setq arg 1))
25d2f683
CW
989 (beginning-of-line)
990 (while (> arg 0)
991 (forward-line -1)
0ce780e1
CW
992 (when (and ibuffer-movement-cycle
993 (or (get-text-property (point) 'ibuffer-title)
994 (and skip-group-names
34a4faa0
JPW
995 (get-text-property (point)
996 'ibuffer-filter-group-name))))
25d2f683 997 (goto-char (point-max))
60356fb5 998 (beginning-of-line))
b5cd37ea
CW
999 (ibuffer-skip-properties (append '(ibuffer-summary)
1000 (when skip-group-names
1001 '(ibuffer-filter-group-name)))
1002 -1)
60356fb5
CW
1003 ;; Handle the special case of no buffers.
1004 (when (get-text-property (point) 'ibuffer-title)
1005 (forward-line 1)
1006 (setq arg 1))
1007 (decf arg)))
25d2f683 1008
b5cd37ea 1009(defun ibuffer-forward-line (&optional arg skip-group-names)
25d2f683
CW
1010 "Move forward ARG lines, wrapping around the list if necessary."
1011 (interactive "P")
34a4faa0 1012 (or arg (setq arg 1))
25d2f683 1013 (beginning-of-line)
0ce780e1
CW
1014 (when (and ibuffer-movement-cycle
1015 (or (eobp)
1016 (get-text-property (point) 'ibuffer-summary)))
214b39be 1017 (goto-char (point-min)))
b5cd37ea
CW
1018 (when (or (get-text-property (point) 'ibuffer-title)
1019 (and skip-group-names
1020 (get-text-property (point) 'ibuffer-filter-group-name)))
1021 (when (> arg 0)
1022 (decf arg))
1023 (ibuffer-skip-properties (append '(ibuffer-title)
1024 (when skip-group-names
1025 '(ibuffer-filter-group-name)))
1026 1))
25d2f683
CW
1027 (if (< arg 0)
1028 (ibuffer-backward-line (- arg))
60356fb5
CW
1029 (while (> arg 0)
1030 (forward-line 1)
0ce780e1
CW
1031 (when (and ibuffer-movement-cycle
1032 (or (eobp)
1033 (get-text-property (point) 'ibuffer-summary)))
60356fb5 1034 (goto-char (point-min)))
b5cd37ea
CW
1035 (decf arg)
1036 (ibuffer-skip-properties (append '(ibuffer-title)
1037 (when skip-group-names
1038 '(ibuffer-filter-group-name)))
1039 1))))
25d2f683 1040
d246cabf
CW
1041(defun ibuffer-visit-buffer (&optional single)
1042 "Visit the buffer on this line.
d246cabf
CW
1043If optional argument SINGLE is non-nil, then also ensure there is only
1044one window."
1045 (interactive "P")
b5cd37ea 1046 (let ((buf (ibuffer-current-buffer t)))
25d2f683 1047 (bury-buffer (current-buffer))
d246cabf
CW
1048 (switch-to-buffer buf)
1049 (when single
1050 (delete-other-windows))))
25d2f683
CW
1051
1052(defun ibuffer-visit-buffer-other-window (&optional noselect)
1053 "Visit the buffer on this line in another window."
1054 (interactive)
b5cd37ea 1055 (let ((buf (ibuffer-current-buffer t)))
25d2f683
CW
1056 (bury-buffer (current-buffer))
1057 (if noselect
1058 (let ((curwin (selected-window)))
1059 (pop-to-buffer buf)
1060 (select-window curwin))
1061 (switch-to-buffer-other-window buf))))
1062
1063(defun ibuffer-visit-buffer-other-window-noselect ()
1064 "Visit the buffer on this line in another window, but don't select it."
1065 (interactive)
1066 (ibuffer-visit-buffer-other-window t))
1067
1068(defun ibuffer-visit-buffer-other-frame ()
1069 "Visit the buffer on this line in another frame."
1070 (interactive)
b5cd37ea 1071 (let ((buf (ibuffer-current-buffer t)))
25d2f683
CW
1072 (bury-buffer (current-buffer))
1073 (switch-to-buffer-other-frame buf)))
1074
1075(defun ibuffer-visit-buffer-1-window ()
1076 "Visit the buffer on this line, and delete other windows."
1077 (interactive)
d246cabf 1078 (ibuffer-visit-buffer t))
25d2f683
CW
1079
1080(defun ibuffer-bury-buffer ()
1081 "Bury the buffer on this line."
1082 (interactive)
b5cd37ea 1083 (let ((buf (ibuffer-current-buffer t))
25d2f683 1084 (line (+ 1 (count-lines 1 (point)))))
25d2f683
CW
1085 (bury-buffer buf)
1086 (ibuffer-update nil t)
1087 (goto-line line)))
1088
1089(defun ibuffer-visit-tags-table ()
1090 "Visit the tags table in the buffer on this line. See `visit-tags-table'."
1091 (interactive)
b5cd37ea 1092 (let ((file (buffer-file-name (ibuffer-current-buffer t))))
25d2f683
CW
1093 (if file
1094 (visit-tags-table file)
1095 (error "Specified buffer has no file"))))
1096
1097(defun ibuffer-do-view (&optional other-frame)
1098 "View marked buffers, or the buffer on the current line.
1099If optional argument OTHER-FRAME is non-nil, then display each
1100marked buffer in a new frame. Otherwise, display each buffer as
1101a new window in the current frame, splitting vertically."
1102 (interactive)
1103 (ibuffer-do-view-1 (if other-frame 'other-frame 'vertically)))
1104
1105(defun ibuffer-do-view-horizontally (&optional other-frame)
1106 "As `ibuffer-do-view', but split windows horizontally."
1107 (interactive)
1108 (ibuffer-do-view-1 (if other-frame 'other-frame 'horizontally)))
1109
1110(defun ibuffer-do-view-1 (type)
1111 (let ((marked-bufs (ibuffer-get-marked-buffers)))
1112 (when (null marked-bufs)
b5cd37ea 1113 (setq marked-bufs (list (ibuffer-current-buffer t))))
25d2f683
CW
1114 (unless (and (eq type 'other-frame)
1115 (not ibuffer-expert)
1116 (> (length marked-bufs) 3)
1117 (not (y-or-n-p (format "Really create a new frame for %s buffers? "
1118 (length marked-bufs)))))
4e4a724c 1119 (set-buffer-modified-p nil)
25d2f683
CW
1120 (delete-other-windows)
1121 (switch-to-buffer (pop marked-bufs))
1122 (let ((height (/ (1- (if (eq type 'horizontally) (frame-width)
4e4a724c 1123 (frame-height)))
25d2f683
CW
1124 (1+ (length marked-bufs)))))
1125 (mapcar (if (eq type 'other-frame)
1126 #'(lambda (buf)
1127 (let ((curframe (selected-frame)))
acf88897 1128 (select-frame (make-frame))
25d2f683
CW
1129 (switch-to-buffer buf)
1130 (select-frame curframe)))
1131 #'(lambda (buf)
1132 (split-window nil height (eq type 'horizontally))
1133 (other-window 1)
1134 (switch-to-buffer buf)))
1135 marked-bufs)))))
1136
1137(defun ibuffer-do-view-other-frame ()
1138 "View each of the marked buffers in a separate frame."
1139 (interactive)
1140 (ibuffer-do-view t))
1141
1142(defsubst ibuffer-map-marked-lines (func)
1143 (prog1 (ibuffer-map-on-mark ibuffer-marked-char func)
1144 (ibuffer-redisplay t)))
1145
1146(defun ibuffer-shrink-to-fit (&optional owin)
1147 (fit-window-to-buffer nil (when owin (/ (frame-height)
1148 (length (window-list (selected-frame)))))))
1149
1150(defun ibuffer-confirm-operation-on (operation names)
1151 "Display a buffer asking whether to perform OPERATION on NAMES."
1152 (or ibuffer-expert
1153 (if (= (length names) 1)
1154 (y-or-n-p (format "Really %s buffer %s? " operation (car names)))
1155 (let ((buf (get-buffer-create "*Ibuffer confirmation*")))
1156 (with-current-buffer buf
1157 (setq buffer-read-only nil)
1158 (erase-buffer)
1159 (ibuffer-columnize-and-insert-list names)
1160 (goto-char (point-min))
1161 (setq buffer-read-only t))
4e4a724c 1162 (let ((lastwin (car (last (window-list nil 'nomini)))))
25d2f683
CW
1163 ;; Now attempt to display the buffer...
1164 (save-window-excursion
1165 (select-window lastwin)
1166 ;; The window might be too small to split; in that case,
7ad5b902 1167 ;; try a few times to increase its size before giving up.
25d2f683
CW
1168 (let ((attempts 0)
1169 (trying t))
1170 (while trying
1171 (condition-case err
1172 (progn
1173 (split-window)
1174 (setq trying nil))
1175 (error
1176 ;; Handle a failure
1177 (if (or (> (incf attempts) 4)
1178 (and (stringp (cadr err))
71296446 1179 ;; This definitely falls in the
4e4a724c 1180 ;; ghetto hack category...
25d2f683
CW
1181 (not (string-match "too small" (cadr err)))))
1182 (apply #'signal err)
1183 (enlarge-window 3))))))
25d2f683
CW
1184 (select-window (next-window))
1185 (switch-to-buffer buf)
1186 (unwind-protect
1187 (progn
1188 (fit-window-to-buffer)
1189 (y-or-n-p (format "Really %s %d buffers? "
1190 operation (length names))))
1191 (kill-buffer buf))))))))
1192
1193(defsubst ibuffer-map-lines-nomodify (function)
1194 "As `ibuffer-map-lines', but don't set the modification flag."
1195 (ibuffer-map-lines function t))
1196
1197(defun ibuffer-buffer-names-with-mark (mark)
1198 (let ((ibuffer-buffer-names-with-mark-result nil))
1199 (ibuffer-map-lines-nomodify
4e4a724c 1200 #'(lambda (buf mk)
25d2f683
CW
1201 (when (char-equal mark mk)
1202 (push (buffer-name buf)
1203 ibuffer-buffer-names-with-mark-result))))
1204 ibuffer-buffer-names-with-mark-result))
1205
1206(defsubst ibuffer-marked-buffer-names ()
1207 (ibuffer-buffer-names-with-mark ibuffer-marked-char))
1208
1209(defsubst ibuffer-deletion-marked-buffer-names ()
1210 (ibuffer-buffer-names-with-mark ibuffer-deletion-char))
1211
1212(defun ibuffer-count-marked-lines (&optional all)
1213 (if all
1214 (ibuffer-map-lines-nomodify
57c9cc3e 1215 #'(lambda (buf mark)
972b8f82 1216 (not (char-equal mark ?\s))))
25d2f683 1217 (ibuffer-map-lines-nomodify
57c9cc3e 1218 #'(lambda (buf mark)
25d2f683
CW
1219 (char-equal mark ibuffer-marked-char)))))
1220
1221(defsubst ibuffer-count-deletion-lines ()
1222 (ibuffer-map-lines-nomodify
57c9cc3e 1223 #'(lambda (buf mark)
25d2f683
CW
1224 (char-equal mark ibuffer-deletion-char))))
1225
1226(defsubst ibuffer-map-deletion-lines (func)
1227 (ibuffer-map-on-mark ibuffer-deletion-char func))
1228
fd225d80 1229(define-ibuffer-op ibuffer-do-save ()
25d2f683
CW
1230 "Save marked buffers as with `save-buffer'."
1231 (:complex t
1232 :opstring "saved"
1233 :modifier-p :maybe)
1234 (when (buffer-modified-p buf)
1235 (if (not (with-current-buffer buf
1236 buffer-file-name))
1237 ;; handle the case where we're prompted
1238 ;; for a file name
1239 (save-window-excursion
1240 (switch-to-buffer buf)
1241 (save-buffer))
1242 (with-current-buffer buf
1243 (save-buffer))))
1244 t)
1245
fd225d80 1246(define-ibuffer-op ibuffer-do-toggle-modified ()
25d2f683
CW
1247 "Toggle modification flag of marked buffers."
1248 (:opstring "(un)marked as modified"
1249 :modifier-p t)
1250 (set-buffer-modified-p (not (buffer-modified-p))))
1251
fd225d80 1252(define-ibuffer-op ibuffer-do-toggle-read-only ()
25d2f683
CW
1253 "Toggle read only status in marked buffers."
1254 (:opstring "toggled read only status in"
1255 :modifier-p t)
1256 (toggle-read-only))
1257
fd225d80 1258(define-ibuffer-op ibuffer-do-delete ()
25d2f683
CW
1259 "Kill marked buffers as with `kill-this-buffer'."
1260 (:opstring "killed"
1261 :active-opstring "kill"
1262 :dangerous t
1263 :complex t
1264 :modifier-p t)
1265 (if (kill-buffer buf)
1266 'kill
1267 nil))
1268
fd225d80 1269(define-ibuffer-op ibuffer-do-kill-on-deletion-marks ()
25d2f683
CW
1270 "Kill buffers marked for deletion as with `kill-this-buffer'."
1271 (:opstring "killed"
1272 :active-opstring "kill"
1273 :dangerous t
1274 :complex t
1275 :mark :deletion
1276 :modifier-p t)
1277 (if (kill-buffer buf)
1278 'kill
1279 nil))
1280
1281(defun ibuffer-unmark-all (mark)
1282 "Unmark all buffers with mark MARK."
1283 (interactive "cRemove marks (RET means all):")
1284 (if (= (ibuffer-count-marked-lines t) 0)
1285 (message "No buffers marked; use 'm' to mark a buffer")
1286 (cond
1287 ((char-equal mark ibuffer-marked-char)
1288 (ibuffer-map-marked-lines
57c9cc3e 1289 #'(lambda (buf mark)
972b8f82 1290 (ibuffer-set-mark-1 ?\s)
25d2f683
CW
1291 t)))
1292 ((char-equal mark ibuffer-deletion-char)
1293 (ibuffer-map-deletion-lines
57c9cc3e 1294 #'(lambda (buf mark)
972b8f82 1295 (ibuffer-set-mark-1 ?\s)
25d2f683
CW
1296 t)))
1297 (t
1298 (ibuffer-map-lines
57c9cc3e 1299 #'(lambda (buf mark)
972b8f82
JB
1300 (when (not (char-equal mark ?\s))
1301 (ibuffer-set-mark-1 ?\s))
25d2f683
CW
1302 t)))))
1303 (ibuffer-redisplay t))
1304
b5cd37ea 1305(defun ibuffer-toggle-marks (&optional group)
25d2f683
CW
1306 "Toggle which buffers are marked.
1307In other words, unmarked buffers become marked, and marked buffers
cba63a2d
CW
1308become unmarked.
1309If point is on a group name, then this function operates on that
1310group."
25d2f683 1311 (interactive)
cba63a2d
CW
1312 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group-name)
1313 (setq group it))
25d2f683
CW
1314 (let ((count
1315 (ibuffer-map-lines
57c9cc3e 1316 #'(lambda (buf mark)
25d2f683 1317 (cond ((eq mark ibuffer-marked-char)
972b8f82 1318 (ibuffer-set-mark-1 ?\s)
25d2f683 1319 nil)
972b8f82 1320 ((eq mark ?\s)
25d2f683
CW
1321 (ibuffer-set-mark-1 ibuffer-marked-char)
1322 t)
1323 (t
b5cd37ea
CW
1324 nil)))
1325 nil group)))
25d2f683
CW
1326 (message "%s buffers marked" count))
1327 (ibuffer-redisplay t))
1328
1329(defun ibuffer-mark-forward (arg)
cba63a2d
CW
1330 "Mark the buffer on this line, and move forward ARG lines.
1331If point is on a group name, this function operates on that group."
25d2f683
CW
1332 (interactive "P")
1333 (ibuffer-mark-interactive arg ibuffer-marked-char 1))
1334
1335(defun ibuffer-unmark-forward (arg)
cba63a2d
CW
1336 "Unmark the buffer on this line, and move forward ARG lines.
1337If point is on a group name, this function operates on that group."
25d2f683 1338 (interactive "P")
972b8f82 1339 (ibuffer-mark-interactive arg ?\s 1))
25d2f683
CW
1340
1341(defun ibuffer-unmark-backward (arg)
cba63a2d
CW
1342 "Unmark the buffer on this line, and move backward ARG lines.
1343If point is on a group name, this function operates on that group."
25d2f683 1344 (interactive "P")
972b8f82 1345 (ibuffer-mark-interactive arg ?\s -1))
25d2f683
CW
1346
1347(defun ibuffer-mark-interactive (arg mark movement)
1348 (assert (eq major-mode 'ibuffer-mode))
34a4faa0 1349 (or arg (setq arg 1))
cba63a2d
CW
1350 (ibuffer-forward-line 0)
1351 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group-name)
1352 (progn
1353 (require 'ibuf-ext)
1354 (ibuffer-mark-on-buffer #'identity mark it))
4e4a724c 1355 (ibuffer-forward-line 0 t)
cba63a2d
CW
1356 (let ((inhibit-read-only t))
1357 (while (> arg 0)
1358 (ibuffer-set-mark mark)
1359 (ibuffer-forward-line movement t)
1360 (setq arg (1- arg))))))
25d2f683
CW
1361
1362(defun ibuffer-set-mark (mark)
1363 (assert (eq major-mode 'ibuffer-mode))
1364 (let ((inhibit-read-only t))
1365 (ibuffer-set-mark-1 mark)
1366 (setq ibuffer-did-modification t)
559ac4c1
CW
1367 (ibuffer-redisplay-current)
1368 (beginning-of-line)))
25d2f683
CW
1369
1370(defun ibuffer-set-mark-1 (mark)
1371 (let ((beg (line-beginning-position))
1372 (end (line-end-position)))
1373 (put-text-property beg end 'ibuffer-properties
1374 (list (ibuffer-current-buffer)
1375 mark))))
1376
1377(defun ibuffer-mark-for-delete (arg)
cba63a2d
CW
1378 "Mark the buffers on ARG lines forward for deletion.
1379If point is on a group name, this function operates on that group."
25d2f683
CW
1380 (interactive "P")
1381 (ibuffer-mark-interactive arg ibuffer-deletion-char 1))
1382
1383(defun ibuffer-mark-for-delete-backwards (arg)
cba63a2d
CW
1384 "Mark the buffers on ARG lines backward for deletion.
1385If point is on a group name, this function operates on that group."
25d2f683
CW
1386 (interactive "P")
1387 (ibuffer-mark-interactive arg ibuffer-deletion-char -1))
1388
1389(defun ibuffer-current-buffer (&optional must-be-live)
1390 (let ((buf (car (get-text-property (line-beginning-position)
1391 'ibuffer-properties))))
b5cd37ea
CW
1392 (when must-be-live
1393 (if (bufferp buf)
1394 (unless (buffer-live-p buf)
1388485d 1395 (error "Buffer %s has been killed; %s" buf (substitute-command-keys "use `\\[ibuffer-update]' to update")))
b5cd37ea 1396 (error "No buffer on this line")))
25d2f683 1397 buf))
523304ed
CW
1398
1399(defun ibuffer-active-formats-name ()
1400 (if (boundp 'ibuffer-filter-format-alist)
1401 (let ((ret nil))
1402 (dolist (filter ibuffer-filtering-qualifiers ret)
1403 (let ((val (assq (car filter) ibuffer-filter-format-alist)))
1404 (when val
1405 (setq ret (car filter)))))
1406 (if ret
1407 ret
1408 :ibuffer-formats))
1409 :ibuffer-formats))
1410
1411(defun ibuffer-current-formats (uncompiledp)
1412 (let* ((name (ibuffer-active-formats-name)))
1413 (ibuffer-check-formats)
1414 (if (eq name :ibuffer-formats)
1415 (if uncompiledp
1416 ibuffer-formats
1417 ibuffer-compiled-formats)
1418 (cadr (assq name
1419 (if uncompiledp
1420 ibuffer-filter-format-alist
1421 ibuffer-compiled-filter-formats))))))
71296446 1422
523304ed 1423(defun ibuffer-current-format (&optional uncompiledp)
25d2f683
CW
1424 (or ibuffer-current-format
1425 (setq ibuffer-current-format 0))
4e4a724c 1426 (nth ibuffer-current-format (ibuffer-current-formats uncompiledp)))
25d2f683
CW
1427
1428(defun ibuffer-expand-format-entry (form)
1429 (if (or (consp form)
1430 (symbolp form))
4e4a724c
JPW
1431 (let ((sym (intern (concat "ibuffer-make-column-"
1432 (symbol-name (if (consp form)
1433 (car form)
1434 form))))))
1435 (unless (or (fboundp sym)
1436 (assq sym ibuffer-inline-columns))
1437 (error "Unknown column %s in ibuffer-formats" form))
1438 (let (min max align elide)
1439 (if (consp form)
1440 (setq min (or (nth 1 form) 0)
1441 max (or (nth 2 form) -1)
1442 align (or (nth 3 form) :left)
1443 elide (or (nth 4 form) nil))
1444 (setq min 0
1445 max -1
1446 align :left
1447 elide nil))
1448 (list sym min max align elide)))
25d2f683 1449 form))
71296446 1450
25d2f683 1451(defun ibuffer-compile-make-eliding-form (strvar elide from-end-p)
545aad2f 1452 (let ((ellipsis (propertize ibuffer-eliding-string 'font-lock-face 'bold)))
63f0a166 1453 (if (or elide (with-no-warnings ibuffer-elide-long-columns))
25d2f683
CW
1454 `(if (> strlen 5)
1455 ,(if from-end-p
1456 `(concat ,ellipsis
1457 (substring ,strvar
1458 (length ibuffer-eliding-string)))
1459 `(concat
1460 (substring ,strvar 0 (- strlen ,(length ellipsis)))
1461 ,ellipsis))
1462 ,strvar)
1463 strvar)))
1464
1465(defun ibuffer-compile-make-substring-form (strvar maxvar from-end-p)
1466 (if from-end-p
1467 `(substring str
1468 (- strlen ,maxvar))
1469 `(substring ,strvar 0 ,maxvar)))
1470
1471(defun ibuffer-compile-make-format-form (strvar widthform alignment)
972b8f82
JB
1472 (let* ((left `(make-string tmp2 ?\s))
1473 (right `(make-string (- tmp1 tmp2) ?\s)))
25d2f683
CW
1474 `(progn
1475 (setq tmp1 ,widthform
1476 tmp2 (/ tmp1 2))
1477 ,(case alignment
1478 (:right `(concat ,left ,right ,strvar))
1479 (:center `(concat ,left ,strvar ,right))
1480 (:left `(concat ,strvar ,left ,right))
1481 (t (error "Invalid alignment %s" alignment))))))
1482
1483(defun ibuffer-compile-format (format)
1484 (let ((result nil)
cb059426
CW
1485 ;; We use these variables to keep track of which variables
1486 ;; inside the generated function we need to bind, since
1487 ;; binding variables in Emacs takes time.
1488 str-used tmp1-used tmp2-used global-strlen-used)
25d2f683
CW
1489 (dolist (form format)
1490 (push
cb059426
CW
1491 ;; Generate a form based on a particular format entry, like
1492 ;; " ", mark, or (mode 16 16 :right).
25d2f683 1493 (if (stringp form)
cb059426 1494 ;; It's a string; all we need to do is insert it.
25d2f683
CW
1495 `(insert ,form)
1496 (let* ((form (ibuffer-expand-format-entry form))
1497 (sym (nth 0 form))
1498 (min (nth 1 form))
1499 (max (nth 2 form))
1500 (align (nth 3 form))
1501 (elide (nth 4 form)))
1502 (let* ((from-end-p (when (minusp min)
1503 (setq min (- min))
1504 t))
1505 (letbindings nil)
1506 (outforms nil)
1507 minform
1508 maxform
1509 min-used max-used strlen-used)
1510 (when (or (not (integerp min)) (>= min 0))
cb059426
CW
1511 ;; This is a complex case; they want it limited to a
1512 ;; minimum size.
25d2f683
CW
1513 (setq min-used t)
1514 (setq str-used t strlen-used t global-strlen-used t
1515 tmp1-used t tmp2-used t)
cb059426 1516 ;; Generate code to limit the string to a minimum size.
25d2f683
CW
1517 (setq minform `(progn
1518 (setq str
1519 ,(ibuffer-compile-make-format-form
1520 'str
1521 `(- ,(if (integerp min)
1522 min
1523 'min)
1524 strlen)
1525 align)))))
1526 (when (or (not (integerp max)) (> max 0))
1527 (setq str-used t max-used t)
cb059426 1528 ;; Generate code to limit the string to a maximum size.
25d2f683
CW
1529 (setq maxform `(progn
1530 (setq str
1531 ,(ibuffer-compile-make-substring-form
1532 'str
1533 (if (integerp max)
1534 max
1535 'max)
1536 from-end-p))
1537 (setq strlen (length str))
1538 (setq str
1539 ,(ibuffer-compile-make-eliding-form 'str
1540 elide
1541 from-end-p)))))
cb059426
CW
1542 ;; Now, put these forms together with the rest of the code.
1543 (let ((callform
1544 ;; Is this an "inline" column? This means we have
1545 ;; to get the code from the
1546 ;; `ibuffer-inline-columns' alist and insert it
1547 ;; into our generated code. Otherwise, we just
1548 ;; generate a call to the column function.
1549 (ibuffer-aif (assq sym ibuffer-inline-columns)
4e4a724c
JPW
1550 (nth 1 it)
1551 `(,sym buffer mark)))
cb059426
CW
1552 ;; You're not expected to understand this. Hell, I
1553 ;; don't even understand it, and I wrote it five
1554 ;; minutes ago.
1555 (insertgenfn (ibuffer-aif (get sym 'ibuffer-column-summarizer)
4e4a724c
JPW
1556 ;; I really, really wish Emacs Lisp had closures.
1557 (lambda (arg sym)
1558 `(insert
1559 (let ((ret ,arg))
1560 (put ',sym 'ibuffer-column-summary
1561 (cons ret (get ',sym 'ibuffer-column-summary)))
1562 ret)))
545aad2f
CW
1563 (lambda (arg sym)
1564 `(insert ,arg))))
25d2f683
CW
1565 (mincompform `(< strlen ,(if (integerp min)
1566 min
1567 'min)))
1568 (maxcompform `(> strlen ,(if (integerp max)
1569 max
1570 'max))))
4e4a724c
JPW
1571 (if (or min-used max-used)
1572 ;; The complex case, where we have to limit the
1573 ;; form to a maximum or minimum size.
1574 (progn
1575 (when (and min-used (not (integerp min)))
1576 (push `(min ,min) letbindings))
1577 (when (and max-used (not (integerp max)))
1578 (push `(max ,max) letbindings))
1579 (push
1580 (if (and min-used max-used)
1581 `(if ,mincompform
1582 ,minform
1583 (if ,maxcompform
1584 ,maxform))
1585 (if min-used
1586 `(when ,mincompform
1587 ,minform)
1588 `(when ,maxcompform
1589 ,maxform)))
1590 outforms)
1591 (push (append
1592 `(setq str ,callform)
1593 (when strlen-used
1594 `(strlen (length str))))
1595 outforms)
1596 (setq outforms
1597 (append outforms (list (funcall insertgenfn 'str sym)))))
1598 ;; The simple case; just insert the string.
1599 (push (funcall insertgenfn callform sym) outforms))
1600 ;; Finally, return a `let' form which binds the
1601 ;; variables in `letbindings', and contains all the
1602 ;; code in `outforms'.
1603 `(let ,letbindings
1604 ,@outforms)))))
25d2f683
CW
1605 result))
1606 (setq result
cb059426 1607 ;; We don't want to unconditionally load the byte-compiler.
25d2f683
CW
1608 (funcall (if (or ibuffer-always-compile-formats
1609 (featurep 'bytecomp))
1610 #'byte-compile
1611 #'identity)
cb059426
CW
1612 ;; Here, we actually create a lambda form which
1613 ;; inserts all the generated forms for each entry
1614 ;; in the format string.
25d2f683 1615 (nconc (list 'lambda '(buffer mark))
d99b259b 1616 `((let ,(append (when str-used
25d2f683
CW
1617 '(str))
1618 (when global-strlen-used
1619 '(strlen))
1620 (when tmp1-used
1621 '(tmp1))
1622 (when tmp2-used
1623 '(tmp2)))
1624 ,@(nreverse result))))))))
1625
25d2f683
CW
1626(defun ibuffer-recompile-formats ()
1627 "Recompile `ibuffer-formats'."
1628 (interactive)
1629 (setq ibuffer-compiled-formats
4e4a724c 1630 (mapcar #'ibuffer-compile-format ibuffer-formats))
523304ed
CW
1631 (when (boundp 'ibuffer-filter-format-alist)
1632 (setq ibuffer-compiled-filter-formats
1633 (mapcar #'(lambda (entry)
1634 (cons (car entry)
1635 (mapcar #'(lambda (formats)
1636 (mapcar #'ibuffer-compile-format formats))
1637 (cdr entry))))
1638 ibuffer-filter-format-alist))))
25d2f683 1639
cb059426
CW
1640(defun ibuffer-clear-summary-columns (format)
1641 (dolist (form format)
1642 (ibuffer-awhen (and (consp form)
1643 (get (car form) 'ibuffer-column-summarizer))
1644 (put (car form) 'ibuffer-column-summary nil))))
71296446 1645
25d2f683 1646(defun ibuffer-check-formats ()
523304ed
CW
1647 (when (null ibuffer-formats)
1648 (error "No formats!"))
b5cd37ea
CW
1649 (let ((ext-loaded (featurep 'ibuf-ext)))
1650 (when (or (null ibuffer-compiled-formats)
1651 (null ibuffer-cached-formats)
1652 (not (eq ibuffer-cached-formats ibuffer-formats))
1653 (null ibuffer-cached-eliding-string)
1654 (not (equal ibuffer-cached-eliding-string ibuffer-eliding-string))
1655 (eql 0 ibuffer-cached-elide-long-columns)
1656 (not (eql ibuffer-cached-elide-long-columns
63f0a166 1657 (with-no-warnings ibuffer-elide-long-columns)))
b5cd37ea
CW
1658 (and ext-loaded
1659 (not (eq ibuffer-cached-filter-formats
1660 ibuffer-filter-format-alist))
1661 (and ibuffer-filter-format-alist
1662 (null ibuffer-compiled-filter-formats))))
1663 (message "Formats have changed, recompiling...")
1664 (ibuffer-recompile-formats)
1665 (setq ibuffer-cached-formats ibuffer-formats
1666 ibuffer-cached-eliding-string ibuffer-eliding-string
63f0a166 1667 ibuffer-cached-elide-long-columns (with-no-warnings ibuffer-elide-long-columns))
b5cd37ea
CW
1668 (when ext-loaded
1669 (setq ibuffer-cached-filter-formats ibuffer-filter-format-alist))
1670 (message "Formats have changed, recompiling...done"))))
25d2f683
CW
1671
1672(defvar ibuffer-inline-columns nil)
1673
1674(define-ibuffer-column mark (:name " " :inline t)
1675 (string mark))
1676
1677(define-ibuffer-column read-only (:name "R" :inline t)
1678 (if buffer-read-only
34a4faa0 1679 (string ibuffer-read-only-char)
25d2f683
CW
1680 " "))
1681
1682(define-ibuffer-column modified (:name "M" :inline t)
1683 (if (buffer-modified-p)
1684 (string ibuffer-modified-char)
1685 " "))
1686
34a4faa0
JPW
1687(define-ibuffer-column name
1688 (:inline t
f0b31589 1689 :header-mouse-map ibuffer-name-header-map
34a4faa0
JPW
1690 :props
1691 ('mouse-face 'highlight 'keymap ibuffer-name-map
1692 'ibuffer-name-column t
1693 'help-echo '(if tooltip-mode
1694 "mouse-1: mark this buffer\nmouse-2: select this buffer\nmouse-3: operate on this buffer"
1695 "mouse-1: mark buffer mouse-2: select buffer mouse-3: operate"))
1696 :summarizer
1697 (lambda (strings)
1698 (let ((bufs (length strings)))
1699 (cond ((zerop bufs) "No buffers")
1700 ((= 1 bufs) "1 buffer")
1701 (t (format "%s buffers" bufs))))))
545aad2f 1702 (propertize (buffer-name) 'font-lock-face (ibuffer-buffer-name-face buffer mark)))
71296446 1703
34a4faa0
JPW
1704(define-ibuffer-column size
1705 (:inline t
f0b31589 1706 :header-mouse-map ibuffer-size-header-map
34a4faa0
JPW
1707 :summarizer
1708 (lambda (column-strings)
1709 (let ((total 0))
1710 (dolist (string column-strings)
1711 (setq total
1712 ;; like, ewww ...
7ad938e7 1713 (+ (float (string-to-number string))
34a4faa0
JPW
1714 total)))
1715 (format "%.0f" total))))
25d2f683
CW
1716 (format "%s" (buffer-size)))
1717
7ad938e7
JPW
1718(define-ibuffer-column mode
1719 (:inline t
f0b31589 1720 :header-mouse-map ibuffer-mode-header-map
7ad938e7
JPW
1721 :props
1722 ('mouse-face 'highlight
1723 'keymap ibuffer-mode-name-map
1724 'help-echo "mouse-2: filter by this mode"))
23eabff6 1725 (format-mode-line mode-name nil nil (current-buffer)))
25d2f683 1726
34a4faa0
JPW
1727(define-ibuffer-column process
1728 (:summarizer
1729 (lambda (strings)
1730 (let ((total (length (delete "" strings))))
1731 (cond ((zerop total) "No processes")
1732 ((= 1 total) "1 process")
1733 (t (format "%d processes" total))))))
96777edb
CW
1734 (ibuffer-aif (get-buffer-process buffer)
1735 (format "(%s %s)" it (process-status it))
34a4faa0
JPW
1736 ""))
1737
1738(define-ibuffer-column filename
1739 (:summarizer
1740 (lambda (strings)
1741 (let ((total (length (delete "" strings))))
1742 (cond ((zerop total) "No files")
1743 ((= 1 total) "1 file")
1744 (t (format "%d files" total))))))
25d2f683
CW
1745 (let ((directory-abbrev-alist ibuffer-directory-abbrev-alist))
1746 (abbreviate-file-name
1747 (or buffer-file-name
1748 (and (boundp 'dired-directory)
2baf64db
JPW
1749 (if (stringp dired-directory)
1750 dired-directory
972b8f82 1751 (car dired-directory)))
25d2f683
CW
1752 ""))))
1753
34a4faa0
JPW
1754(define-ibuffer-column filename-and-process
1755 (:name "Filename/Process"
1756 :summarizer
1757 (lambda (strings)
1758 (setq strings (delete "" strings))
1759 (let ((procs 0)
1760 (files 0))
1761 (dolist (string strings)
1762 (if (string-match "\\(\?:\\`(\[\[:ascii:\]\]\+)\\)" string)
1763 (progn (setq procs (1+ procs))
1764 (if (< (match-end 0) (length string))
1765 (setq files (1+ files))))
1766 (setq files (1+ files))))
1767 (concat (cond ((zerop files) "No files")
1768 ((= 1 files) "1 file")
1769 (t (format "%d files" files)))
1770 ", "
1771 (cond ((zerop procs) "no processes")
1772 ((= 1 procs) "1 process")
1773 (t (format "%d processes" procs)))))))
fd225d80 1774 (let ((proc (get-buffer-process buffer))
63e0bf5e 1775 (filename (ibuffer-make-column-filename buffer mark)))
fd225d80 1776 (if proc
34a4faa0 1777 (concat (propertize (format "(%s %s)" proc (process-status proc))
545aad2f 1778 'font-lock-face 'italic)
34a4faa0
JPW
1779 (if (> (length filename) 0)
1780 (format " %s" filename)
1781 ""))
fd225d80
CW
1782 filename)))
1783
25d2f683 1784(defun ibuffer-format-column (str width alignment)
972b8f82
JB
1785 (let ((left (make-string (/ width 2) ?\s))
1786 (right (make-string (- width (/ width 2)) ?\s)))
25d2f683
CW
1787 (case alignment
1788 (:right (concat left right str))
1789 (:center (concat left str right))
1790 (t (concat str left right)))))
1791
545aad2f 1792(defun ibuffer-buffer-name-face (buf mark)
fd225d80 1793 (cond ((char-equal mark ibuffer-marked-char)
545aad2f 1794 ibuffer-marked-face)
fd225d80 1795 ((char-equal mark ibuffer-deletion-char)
545aad2f 1796 ibuffer-deletion-face)
fd225d80
CW
1797 (t
1798 (let ((level -1)
fd225d80
CW
1799 result)
1800 (dolist (e ibuffer-fontification-alist result)
1801 (when (and (> (car e) level)
1802 (with-current-buffer buf
545aad2f 1803 (eval (nth 1 e))))
fd225d80 1804 (setq level (car e)
545aad2f 1805 result (nth 2 e))))))))
25d2f683
CW
1806
1807(defun ibuffer-insert-buffer-line (buffer mark format)
1808 "Insert a line describing BUFFER and MARK using FORMAT."
1809 (assert (eq major-mode 'ibuffer-mode))
1810 (let ((beg (point)))
25d2f683 1811 (funcall format buffer mark)
cb059426
CW
1812 (put-text-property beg (point) 'ibuffer-properties (list buffer mark)))
1813 (insert "\n"))
25d2f683 1814
cb059426 1815;; This function knows a bit too much of the internals. It would be
b5cd37ea 1816;; nice if it was all abstracted away.
25d2f683
CW
1817(defun ibuffer-redisplay-current ()
1818 (assert (eq major-mode 'ibuffer-mode))
1819 (when (eobp)
1820 (forward-line -1))
1821 (beginning-of-line)
cb059426
CW
1822 (let ((curformat (mapcar #'ibuffer-expand-format-entry
1823 (ibuffer-current-format t))))
1824 (ibuffer-clear-summary-columns curformat)
1825 (let ((buf (ibuffer-current-buffer)))
1826 (when buf
1827 (let ((mark (ibuffer-current-mark)))
ed233dd8
CW
1828 (save-excursion
1829 (delete-region (point) (1+ (line-end-position)))
1830 (ibuffer-insert-buffer-line
1831 buf mark
1832 (ibuffer-current-format)))
cb059426
CW
1833 (when ibuffer-shrink-to-minimum-size
1834 (ibuffer-shrink-to-fit)))))))
71296446 1835
25d2f683
CW
1836(defun ibuffer-map-on-mark (mark func)
1837 (ibuffer-map-lines
57c9cc3e 1838 #'(lambda (buf mk)
25d2f683 1839 (if (char-equal mark mk)
57c9cc3e 1840 (funcall func buf mark)
25d2f683
CW
1841 nil))))
1842
b5cd37ea
CW
1843(defun ibuffer-map-lines (function &optional nomodify group)
1844 "Call FUNCTION for each buffer.
4837b516 1845Set the ibuffer modification flag unless NOMODIFY is non-nil.
25d2f683 1846
b5cd37ea
CW
1847If optional argument GROUP is non-nil, then only call FUNCTION on
1848buffers in filtering group GROUP.
1849
4e4a724c
JPW
1850FUNCTION is called with two arguments:
1851the buffer object itself and the current mark symbol."
25d2f683 1852 (assert (eq major-mode 'ibuffer-mode))
b5cd37ea
CW
1853 (ibuffer-forward-line 0)
1854 (let* ((orig-target-line (1+ (count-lines (save-excursion
1855 (goto-char (point-min))
1856 (ibuffer-forward-line 0)
1857 (point))
1858 (point))))
1859 (target-line-offset orig-target-line)
1860 (ibuffer-map-lines-total 0)
1861 (ibuffer-map-lines-count 0))
25d2f683 1862 (unwind-protect
57c9cc3e
CW
1863 (progn
1864 (setq buffer-read-only nil)
1865 (goto-char (point-min))
4e4a724c 1866 (ibuffer-forward-line 0 t)
57c9cc3e 1867 (while (and (not (eobp))
b5cd37ea
CW
1868 (not (get-text-property (point) 'ibuffer-summary))
1869 (progn
1870 (ibuffer-forward-line 0 t)
1871 (and (not (eobp))
1872 (not (get-text-property (point) 'ibuffer-summary)))))
57c9cc3e
CW
1873 (let ((result
1874 (if (buffer-live-p (ibuffer-current-buffer))
b5cd37ea
CW
1875 (when (or (null group)
1876 (ibuffer-aif (get-text-property (point) 'ibuffer-filter-group)
1877 (equal group it)))
1878 (save-excursion
1879 (funcall function
1880 (ibuffer-current-buffer)
1881 (ibuffer-current-mark))))
57c9cc3e
CW
1882 ;; Kill the line if the buffer is dead
1883 'kill)))
1884 ;; A given mapping function should return:
1885 ;; `nil' if it chose not to affect the buffer
1886 ;; `kill' means the remove line from the buffer list
1887 ;; `t' otherwise
1888 (incf ibuffer-map-lines-total)
1889 (cond ((null result)
1890 (forward-line 1))
1891 ((eq result 'kill)
1892 (delete-region (line-beginning-position)
1893 (1+ (line-end-position)))
1894 (incf ibuffer-map-lines-count)
1895 (when (< ibuffer-map-lines-total
4e4a724c 1896 orig-target-line)
b5cd37ea 1897 (decf target-line-offset)))
57c9cc3e
CW
1898 (t
1899 (incf ibuffer-map-lines-count)
1900 (forward-line 1)))))
1901 ibuffer-map-lines-count)
25d2f683
CW
1902 (progn
1903 (setq buffer-read-only t)
1904 (unless nomodify
1905 (set-buffer-modified-p nil))
57c9cc3e
CW
1906 (goto-char (point-min))
1907 (ibuffer-forward-line 0)
b5cd37ea 1908 (ibuffer-forward-line (1- target-line-offset))))))
25d2f683
CW
1909
1910(defun ibuffer-get-marked-buffers ()
1911 "Return a list of buffer objects currently marked."
1912 (delq nil
1913 (mapcar #'(lambda (e)
1914 (when (eq (cdr e) ibuffer-marked-char)
1915 (car e)))
1916 (ibuffer-current-state-list))))
1917
d246cabf
CW
1918(defun ibuffer-current-state-list (&optional pos)
1919 "Return a list like (BUF . MARK) of all buffers in an ibuffer.
1920If POS is non-nil, return a list like (BUF MARK POINT), where POINT is
1921the value of point at the beginning of the line for that buffer."
25d2f683
CW
1922 (let ((ibuffer-current-state-list-tmp '()))
1923 ;; ah, if only we had closures. I bet this will mysteriously
1924 ;; break later. Don't blame me.
d246cabf
CW
1925 (if pos
1926 (ibuffer-map-lines-nomodify
1927 #'(lambda (buf mark)
1928 (when (buffer-live-p buf)
1929 (push (list buf mark (point)) ibuffer-current-state-list-tmp))))
1930 (ibuffer-map-lines-nomodify
1931 #'(lambda (buf mark)
1932 (when (buffer-live-p buf)
1933 (push (cons buf mark) ibuffer-current-state-list-tmp)))))
25d2f683
CW
1934 (nreverse ibuffer-current-state-list-tmp)))
1935
851476d4 1936(defun ibuffer-current-buffers-with-marks (curbufs)
25d2f683
CW
1937 "Return a list like (BUF . MARK) of all open buffers."
1938 (let ((bufs (ibuffer-current-state-list)))
1939 (mapcar #'(lambda (buf) (let ((e (assq buf bufs)))
1940 (if e
1941 e
972b8f82 1942 (cons buf ?\s))))
851476d4 1943 curbufs)))
25d2f683
CW
1944
1945(defun ibuffer-buf-matches-predicates (buf predicates)
1946 (let ((hit nil)
1947 (name (buffer-name buf)))
1948 (dolist (pred predicates)
1949 (when (if (stringp pred)
1950 (string-match pred name)
1951 (funcall pred buf))
1952 (setq hit t)))
1953 hit))
71296446 1954
25d2f683
CW
1955(defun ibuffer-filter-buffers (ibuffer-buf last bmarklist all)
1956 (let ((ext-loaded (featurep 'ibuf-ext)))
1957 (delq nil
b5cd37ea
CW
1958 (mapcar
1959 ;; element should be like (BUFFER . MARK)
1960 #'(lambda (e)
1961 (let* ((buf (car e)))
1962 (when
1963 ;; This takes precedence over anything else
1964 (or (and ibuffer-always-show-last-buffer
4e4a724c
JPW
1965 (eq last buf))
1966 (funcall (if ext-loaded
1967 #'ibuffer-ext-visible-p
1968 #'ibuffer-visible-p)
1969 buf all ibuffer-buf))
b5cd37ea
CW
1970 e)))
1971 bmarklist))))
25d2f683
CW
1972
1973(defun ibuffer-visible-p (buf all &optional ibuffer-buf)
1974 (and (or all
1975 (not
1976 (ibuffer-buf-matches-predicates buf ibuffer-maybe-show-predicates)))
1977 (or ibuffer-view-ibuffer
4e4a724c 1978 (and ibuffer-buf
25d2f683
CW
1979 (not (eq ibuffer-buf buf))))))
1980
1981;; This function is a special case; it's not defined by
6081889e 1982;; `define-ibuffer-sorter'.
25d2f683
CW
1983(defun ibuffer-do-sort-by-recency ()
1984 "Sort the buffers by last view time."
1985 (interactive)
1986 (setq ibuffer-sorting-mode 'recency)
6081889e 1987 (ibuffer-update nil t))
25d2f683
CW
1988
1989(defun ibuffer-update-format ()
1990 (when (null ibuffer-current-format)
1991 (setq ibuffer-current-format 0))
1992 (when (null ibuffer-formats)
1993 (error "Ibuffer error: no formats!")))
1994
1995(defun ibuffer-switch-format ()
1996 "Switch the current display format."
1997 (interactive)
1998 (assert (eq major-mode 'ibuffer-mode))
1999 (unless (consp ibuffer-formats)
2000 (error "Ibuffer error: No formats!"))
2001 (setq ibuffer-current-format
80a06d64 2002 (if (>= ibuffer-current-format (1- (length (ibuffer-current-formats nil))))
25d2f683
CW
2003 0
2004 (1+ ibuffer-current-format)))
2005 (ibuffer-update-format)
2006 (ibuffer-redisplay t))
2007
cb059426 2008(defun ibuffer-update-title-and-summary (format)
25d2f683
CW
2009 (assert (eq major-mode 'ibuffer-mode))
2010 ;; Don't do funky font-lock stuff here
2011 (let ((after-change-functions nil))
2012 (if (get-text-property (point-min) 'ibuffer-title)
2013 (delete-region (point-min)
2014 (next-single-property-change
2015 (point-min) 'ibuffer-title)))
2016 (goto-char (point-min))
fd225d80 2017 (add-text-properties
25d2f683
CW
2018 (point)
2019 (progn
2020 (let ((opos (point)))
2021 ;; Insert the title names.
cb059426 2022 (dolist (element format)
25d2f683
CW
2023 (insert
2024 (if (stringp element)
2025 element
2026 (let ((sym (car element))
2027 (min (cadr element))
2028 ;; (max (caddr element))
2029 (align (cadddr element)))
4e4a724c 2030 ;; Ignore a negative min when we're inserting the title
25d2f683
CW
2031 (when (minusp min)
2032 (setq min (- min)))
2033 (let* ((name (or (get sym 'ibuffer-column-name)
2034 (error "Unknown column %s in ibuffer-formats" sym)))
f0b31589
DN
2035 (len (length name))
2036 (hmap (get sym 'header-mouse-map))
2037 (strname (if (< len min)
2038 (ibuffer-format-column name
2039 (- min len)
2040 align)
2041 name)))
2042 (when hmap
2043 (setq
2044 strname
2045 (propertize strname 'mouse-face 'highlight 'keymap hmap)))
2046 strname)))))
fd225d80 2047 (add-text-properties opos (point) `(ibuffer-title-header t))
25d2f683
CW
2048 (insert "\n")
2049 ;; Add the underlines
2050 (let ((str (save-excursion
2051 (forward-line -1)
2052 (beginning-of-line)
2053 (buffer-substring (point) (line-end-position)))))
2054 (apply #'insert (mapcar
2055 #'(lambda (c)
972b8f82 2056 (if (not (or (char-equal c ?\s)
25d2f683
CW
2057 (char-equal c ?\n)))
2058 ?-
972b8f82 2059 ?\s))
25d2f683
CW
2060 str)))
2061 (insert "\n"))
2062 (point))
545aad2f 2063 `(ibuffer-title t font-lock-face ,ibuffer-title-face))
cb059426
CW
2064 ;; Now, insert the summary columns.
2065 (goto-char (point-max))
2066 (if (get-text-property (1- (point-max)) 'ibuffer-summary)
2067 (delete-region (previous-single-property-change
2068 (point-max) 'ibuffer-summary)
2069 (point-max)))
0740098c
JPW
2070 (if ibuffer-display-summary
2071 (add-text-properties
2072 (point)
2073 (progn
2074 (insert "\n")
2075 (dolist (element format)
2076 (insert
2077 (if (stringp element)
972b8f82 2078 (make-string (length element) ?\s)
0740098c
JPW
2079 (let ((sym (car element)))
2080 (let ((min (cadr element))
2081 ;; (max (caddr element))
2082 (align (cadddr element)))
2083 ;; Ignore a negative min when we're inserting the title
2084 (when (minusp min)
2085 (setq min (- min)))
2086 (let* ((summary (if (get sym 'ibuffer-column-summarizer)
2087 (funcall (get sym 'ibuffer-column-summarizer)
2088 (get sym 'ibuffer-column-summary))
2089 (make-string (length (get sym 'ibuffer-column-name))
972b8f82 2090 ?\s)))
0740098c
JPW
2091 (len (length summary)))
2092 (if (< len min)
2093 (ibuffer-format-column summary
2094 (- min len)
2095 align)
2096 summary)))))))
2097 (point))
2098 `(ibuffer-summary t)))))
25d2f683 2099
25d2f683
CW
2100
2101(defun ibuffer-redisplay (&optional silent)
2102 "Redisplay the current list of buffers.
25d2f683
CW
2103This does not show new buffers; use `ibuffer-update' for that.
2104
7ad5b902 2105If optional arg SILENT is non-nil, do not display progress messages."
25d2f683 2106 (interactive)
57c9cc3e 2107 (ibuffer-forward-line 0)
25d2f683
CW
2108 (unless silent
2109 (message "Redisplaying current buffer list..."))
2110 (let ((blist (ibuffer-current-state-list)))
2111 (when (null blist)
2112 (if (and (featurep 'ibuf-ext)
cba63a2d 2113 (or ibuffer-filtering-qualifiers ibuffer-hidden-filter-groups))
25d2f683
CW
2114 (message "No buffers! (note: filtering in effect)")
2115 (error "No buffers!")))
b5cd37ea 2116 (ibuffer-redisplay-engine blist t)
25d2f683 2117 (unless silent
57c9cc3e
CW
2118 (message "Redisplaying current buffer list...done"))
2119 (ibuffer-forward-line 0)))
25d2f683
CW
2120
2121(defun ibuffer-update (arg &optional silent)
2122 "Regenerate the list of all buffers.
957237cb
JPW
2123
2124Prefix arg non-nil means to toggle whether buffers that match
2125`ibuffer-maybe-show-predicates' should be displayed.
25d2f683 2126
7ad5b902 2127If optional arg SILENT is non-nil, do not display progress messages."
25d2f683 2128 (interactive "P")
957237cb
JPW
2129 (if arg
2130 (setq ibuffer-display-maybe-show-predicates
2131 (not ibuffer-display-maybe-show-predicates)))
57c9cc3e 2132 (ibuffer-forward-line 0)
25d2f683
CW
2133 (let* ((bufs (buffer-list))
2134 (blist (ibuffer-filter-buffers
94394914
JPW
2135 (current-buffer)
2136 (if (and
2137 (cadr bufs)
2138 (eq ibuffer-always-show-last-buffer
2139 :nomini)
8e7dbfdb 2140 (minibufferp (cadr bufs)))
da337a28 2141 (caddr bufs)
94394914
JPW
2142 (cadr bufs))
2143 (ibuffer-current-buffers-with-marks bufs)
957237cb 2144 ibuffer-display-maybe-show-predicates)))
25d2f683
CW
2145 (when (null blist)
2146 (if (and (featurep 'ibuf-ext)
2147 ibuffer-filtering-qualifiers)
2148 (message "No buffers! (note: filtering in effect)")
2149 (error "No buffers!")))
2150 (unless silent
2151 (message "Updating buffer list..."))
b5cd37ea 2152 (ibuffer-redisplay-engine blist arg)
25d2f683
CW
2153 (unless silent
2154 (message "Updating buffer list...done")))
2155 (if (eq ibuffer-shrink-to-minimum-size 'onewindow)
2156 (ibuffer-shrink-to-fit t)
2157 (when ibuffer-shrink-to-minimum-size
2158 (ibuffer-shrink-to-fit)))
2159 (ibuffer-forward-line 0))
2160
b5cd37ea
CW
2161(defun ibuffer-sort-bufferlist (bmarklist)
2162 (let* ((sortdat (assq ibuffer-sorting-mode
2163 ibuffer-sorting-functions-alist))
2164 (func (caddr sortdat)))
2165 (let ((result
2166 ;; actually sort the buffers
2167 (if (and sortdat func)
2168 (sort bmarklist func)
2169 bmarklist)))
2170 ;; perhaps reverse the sorted buffer list
2171 (if ibuffer-sorting-reversep
2172 (nreverse result)
2173 result))))
2174
7fbac645 2175(defun ibuffer-insert-filter-group (name display-name filter-string format bmarklist)
b5cd37ea
CW
2176 (add-text-properties
2177 (point)
2178 (progn
2179 (insert "[ " display-name " ]")
2180 (point))
fd225d80
CW
2181 `(ibuffer-filter-group-name
2182 ,name
545aad2f 2183 font-lock-face ,ibuffer-filter-group-name-face
fd225d80
CW
2184 keymap ,ibuffer-mode-filter-group-map
2185 mouse-face highlight
1cd7affa
JPW
2186 help-echo ,(let ((echo '(if tooltip-mode
2187 "mouse-1: toggle marks in this group\nmouse-2: hide/show this filtering group"
ce3a4c83 2188 "mouse-1: toggle marks mouse-2: hide/show")))
1cd7affa 2189 (if (> (length filter-string) 0)
ce3a4c83
JPW
2190 `(concat ,filter-string
2191 (if tooltip-mode "\n" " ")
2192 ,echo)
1cd7affa 2193 echo))))
b5cd37ea
CW
2194 (insert "\n")
2195 (when bmarklist
2196 (put-text-property
2197 (point)
2198 (progn
2199 (dolist (entry bmarklist)
2200 (ibuffer-insert-buffer-line (car entry) (cdr entry) format))
2201 (point))
2202 'ibuffer-filter-group
2203 name)))
2204
957237cb 2205(defun ibuffer-redisplay-engine (bmarklist &optional ignore)
25d2f683 2206 (assert (eq major-mode 'ibuffer-mode))
b5cd37ea
CW
2207 (let* ((--ibuffer-insert-buffers-and-marks-format
2208 (ibuffer-current-format))
2209 (--ibuffer-expanded-format (mapcar #'ibuffer-expand-format-entry
2210 (ibuffer-current-format t)))
2211 (orig (count-lines (point-min) (point)))
2212 ;; Inhibit font-lock caching tricks, since we're modifying the
2213 ;; entire buffer at once
2214 (after-change-functions nil)
2215 (ext-loaded (featurep 'ibuf-ext))
2216 (bgroups (if ext-loaded
2217 (ibuffer-generate-filter-groups bmarklist)
2218 (list (cons "Default" bmarklist)))))
cb059426 2219 (ibuffer-clear-summary-columns --ibuffer-expanded-format)
25d2f683
CW
2220 (unwind-protect
2221 (progn
2222 (setq buffer-read-only nil)
2223 (erase-buffer)
2224 (ibuffer-update-format)
b5cd37ea
CW
2225 (dolist (group (nreverse bgroups))
2226 (let* ((name (car group))
2227 (disabled (and ext-loaded
cba63a2d 2228 (member name ibuffer-hidden-filter-groups)))
b5cd37ea 2229 (bmarklist (cdr group)))
cba63a2d 2230 (unless (and (null bmarklist)
b90a6a12 2231 (not disabled)
cba63a2d
CW
2232 ext-loaded
2233 (null ibuffer-show-empty-filter-groups))
2234 (ibuffer-insert-filter-group
2235 name
2236 (if disabled (concat name " ...") name)
7fbac645
CW
2237 (if ext-loaded
2238 (ibuffer-format-filter-group-data name)
2239 "")
cba63a2d
CW
2240 --ibuffer-insert-buffers-and-marks-format
2241 (if disabled
2242 nil
2243 (ibuffer-sort-bufferlist bmarklist))))))
cb059426 2244 (ibuffer-update-title-and-summary --ibuffer-expanded-format))
25d2f683
CW
2245 (setq buffer-read-only t)
2246 (set-buffer-modified-p ibuffer-did-modification)
2247 (setq ibuffer-did-modification nil)
2248 (goto-line (1+ orig)))))
2249
2250(defun ibuffer-quit ()
2251 "Quit this `ibuffer' session.
4837b516 2252Try to restore the previous window configuration if
4ed1f829 2253`ibuffer-restore-window-config-on-quit' is non-nil."
25d2f683 2254 (interactive)
4ed1f829 2255 (if ibuffer-restore-window-config-on-quit
7ad938e7 2256 (progn
25d2f683
CW
2257 (bury-buffer)
2258 (unless (= (count-windows) 1)
4ed1f829 2259 (set-window-configuration ibuffer-prev-window-config)))
25d2f683
CW
2260 (bury-buffer)))
2261
2262;;;###autoload
2263(defun ibuffer-list-buffers (&optional files-only)
2264 "Display a list of buffers, in another window.
2265If optional argument FILES-ONLY is non-nil, then add a filter for
2266buffers which are visiting a file."
2267 (interactive "P")
2268 (ibuffer t nil (when files-only
2269 '((filename . ".*"))) t))
2270
2271;;;###autoload
2272(defun ibuffer-other-window (&optional files-only)
2273 "Like `ibuffer', but displayed in another window by default.
2274If optional argument FILES-ONLY is non-nil, then add a filter for
2275buffers which are visiting a file."
2276 (interactive "P")
2277 (ibuffer t nil (when files-only
2278 '((filename . ".*")))))
2279
2280;;;###autoload
b5cd37ea 2281(defun ibuffer (&optional other-window-p name qualifiers noselect
fd225d80 2282 shrink filter-groups formats)
972b8f82 2283 "Begin using Ibuffer to edit a list of buffers.
25d2f683
CW
2284Type 'h' after entering ibuffer for more information.
2285
972b8f82
JB
2286All arguments are optional.
2287OTHER-WINDOW-P says to use another window.
2288NAME specifies the name of the buffer (defaults to \"*Ibuffer*\").
2289QUALIFIERS is an initial set of filtering qualifiers to use;
2290 see `ibuffer-filtering-qualifiers'.
2291NOSELECT means don't select the Ibuffer buffer.
2292SHRINK means shrink the buffer to minimal size. The special
2293 value `onewindow' means always use another window.
2294FILTER-GROUPS is an initial set of filtering groups to use;
2295 see `ibuffer-filter-groups'.
2296FORMATS is the value to use for `ibuffer-formats'.
2297 If specified, then the variable `ibuffer-formats' will have
2298 that value locally in this buffer."
25d2f683
CW
2299 (interactive "P")
2300 (when ibuffer-use-other-window
34b8f593 2301 (setq other-window-p t))
4ed1f829 2302 (setq ibuffer-prev-window-config (current-window-configuration))
34a4faa0 2303 (let ((buf (get-buffer-create (or name "*Ibuffer*"))))
25d2f683
CW
2304 (if other-window-p
2305 (funcall (if noselect #'(lambda (buf) (display-buffer buf t)) #'pop-to-buffer) buf)
2306 (funcall (if noselect #'display-buffer #'switch-to-buffer) buf))
2307 (with-current-buffer buf
b5cd37ea
CW
2308 (save-selected-window
2309 ;; We switch to the buffer's window in order to be able
2310 ;; to modify the value of point
fab0d308 2311 (select-window (get-buffer-window buf 0))
34a4faa0
JPW
2312 (or (eq major-mode 'ibuffer-mode)
2313 (ibuffer-mode))
4ed1f829 2314 (setq ibuffer-restore-window-config-on-quit other-window-p)
b5cd37ea
CW
2315 (when shrink
2316 (setq ibuffer-shrink-to-minimum-size shrink))
2317 (when qualifiers
2318 (require 'ibuf-ext)
2319 (setq ibuffer-filtering-qualifiers qualifiers))
2320 (when filter-groups
2321 (require 'ibuf-ext)
cba63a2d 2322 (setq ibuffer-filter-groups filter-groups))
fd225d80
CW
2323 (when formats
2324 (set (make-local-variable 'ibuffer-formats) formats))
b5cd37ea
CW
2325 (ibuffer-update nil)
2326 ;; Skip the group name by default.
2327 (ibuffer-forward-line 0 t)
25d2f683
CW
2328 (unwind-protect
2329 (progn
b5cd37ea 2330 (setq buffer-read-only nil)
7ad5b902 2331 (run-hooks 'ibuffer-hook))
b5cd37ea
CW
2332 (setq buffer-read-only t))
2333 (unless ibuffer-expert
2334 (message "Commands: m, u, t, RET, g, k, S, D, Q; q to quit; h for help"))))))
25d2f683 2335
b23af469 2336(put 'ibuffer-mode 'mode-class 'special)
25d2f683
CW
2337(defun ibuffer-mode ()
2338 "A major mode for viewing a list of buffers.
972b8f82 2339In Ibuffer, you can conveniently perform many operations on the
25d2f683
CW
2340currently open buffers, in addition to filtering your view to a
2341particular subset of them, and sorting by various criteria.
2342
2343Operations on marked buffers:
2344
2345 '\\[ibuffer-do-save]' - Save the marked buffers
2346 '\\[ibuffer-do-view]' - View the marked buffers in this frame.
2347 '\\[ibuffer-do-view-other-frame]' - View the marked buffers in another frame.
2348 '\\[ibuffer-do-revert]' - Revert the marked buffers.
2349 '\\[ibuffer-do-toggle-read-only]' - Toggle read-only state of marked buffers.
2350 '\\[ibuffer-do-delete]' - Kill the marked buffers.
2351 '\\[ibuffer-do-replace-regexp]' - Replace by regexp in each of the marked
2352 buffers.
2353 '\\[ibuffer-do-query-replace]' - Query replace in each of the marked buffers.
2354 '\\[ibuffer-do-query-replace-regexp]' - As above, with a regular expression.
2355 '\\[ibuffer-do-print]' - Print the marked buffers.
2356 '\\[ibuffer-do-occur]' - List lines in all marked buffers which match
2357 a given regexp (like the function `occur').
2358 '\\[ibuffer-do-shell-command-pipe]' - Pipe the contents of the marked
2359 buffers to a shell command.
2360 '\\[ibuffer-do-shell-command-pipe-replace]' - Replace the contents of the marked
2361 buffers with the output of a shell command.
2362 '\\[ibuffer-do-shell-command-file]' - Run a shell command with the
2363 buffer's file as an argument.
2364 '\\[ibuffer-do-eval]' - Evaluate a form in each of the marked buffers. This
2365 is a very flexible command. For example, if you want to make all
2366 of the marked buffers read only, try using (toggle-read-only 1) as
2367 the input form.
2368 '\\[ibuffer-do-view-and-eval]' - As above, but view each buffer while the form
2369 is evaluated.
2370 '\\[ibuffer-do-kill-lines]' - Remove the marked lines from the *Ibuffer* buffer,
2371 but don't kill the associated buffer.
2372 '\\[ibuffer-do-kill-on-deletion-marks]' - Kill all buffers marked for deletion.
2373
2374Marking commands:
2375
2376 '\\[ibuffer-mark-forward]' - Mark the buffer at point.
2377 '\\[ibuffer-toggle-marks]' - Unmark all currently marked buffers, and mark
2378 all unmarked buffers.
2379 '\\[ibuffer-unmark-forward]' - Unmark the buffer at point.
2380 '\\[ibuffer-unmark-backward]' - Unmark the buffer at point, and move to the
2381 previous line.
2382 '\\[ibuffer-unmark-all]' - Unmark all marked buffers.
2383 '\\[ibuffer-mark-by-mode]' - Mark buffers by major mode.
2384 '\\[ibuffer-mark-unsaved-buffers]' - Mark all \"unsaved\" buffers.
2385 This means that the buffer is modified, and has an associated file.
2386 '\\[ibuffer-mark-modified-buffers]' - Mark all modified buffers,
2387 regardless of whether or not they have an associated file.
2388 '\\[ibuffer-mark-special-buffers]' - Mark all buffers whose name begins and
2389 ends with '*'.
2390 '\\[ibuffer-mark-dissociated-buffers]' - Mark all buffers which have
2391 an associated file, but that file doesn't currently exist.
2392 '\\[ibuffer-mark-read-only-buffers]' - Mark all read-only buffers.
2393 '\\[ibuffer-mark-dired-buffers]' - Mark buffers in `dired' mode.
2394 '\\[ibuffer-mark-help-buffers]' - Mark buffers in `help-mode', `apropos-mode', etc.
2395 '\\[ibuffer-mark-old-buffers]' - Mark buffers older than `ibuffer-old-time'.
2396 '\\[ibuffer-mark-for-delete]' - Mark the buffer at point for deletion.
2397 '\\[ibuffer-mark-by-name-regexp]' - Mark buffers by their name, using a regexp.
2398 '\\[ibuffer-mark-by-mode-regexp]' - Mark buffers by their major mode, using a regexp.
2399 '\\[ibuffer-mark-by-file-name-regexp]' - Mark buffers by their filename, using a regexp.
2400
2401Filtering commands:
2402
2403 '\\[ibuffer-filter-by-mode]' - Add a filter by major mode.
5bc06df9 2404 '\\[ibuffer-filter-by-used-mode]' - Add a filter by major mode now in use.
25d2f683
CW
2405 '\\[ibuffer-filter-by-name]' - Add a filter by buffer name.
2406 '\\[ibuffer-filter-by-content]' - Add a filter by buffer content.
2407 '\\[ibuffer-filter-by-filename]' - Add a filter by filename.
2408 '\\[ibuffer-filter-by-size-gt]' - Add a filter by buffer size.
2409 '\\[ibuffer-filter-by-size-lt]' - Add a filter by buffer size.
2410 '\\[ibuffer-filter-by-predicate]' - Add a filter by an arbitrary Lisp predicate.
2411 '\\[ibuffer-save-filters]' - Save the current filters with a name.
2412 '\\[ibuffer-switch-to-saved-filters]' - Switch to previously saved filters.
2413 '\\[ibuffer-add-saved-filters]' - Add saved filters to current filters.
2414 '\\[ibuffer-or-filter]' - Replace the top two filters with their logical OR.
2415 '\\[ibuffer-pop-filter]' - Remove the top filter.
2416 '\\[ibuffer-negate-filter]' - Invert the logical sense of the top filter.
2417 '\\[ibuffer-decompose-filter]' - Break down the topmost filter.
2418 '\\[ibuffer-filter-disable]' - Remove all filtering currently in effect.
cba63a2d
CW
2419
2420Filter group commands:
2421
2422 '\\[ibuffer-filters-to-filter-group]' - Create filter group from filters.
2423 '\\[ibuffer-pop-filter-group]' - Remove top filter group.
b098e753
CW
2424 '\\[ibuffer-forward-filter-group]' - Move to the next filter group.
2425 '\\[ibuffer-backward-filter-group]' - Move to the previous filter group.
2426 '\\[ibuffer-clear-filter-groups]' - Remove all active filter groups.
2427 '\\[ibuffer-save-filter-groups]' - Save the current groups with a name.
2428 '\\[ibuffer-switch-to-saved-filter-groups]' - Restore previously saved groups.
2429 '\\[ibuffer-delete-saved-filter-groups]' - Delete previously saved groups.
71296446 2430
25d2f683
CW
2431Sorting commands:
2432
2433 '\\[ibuffer-toggle-sorting-mode]' - Rotate between the various sorting modes.
2434 '\\[ibuffer-invert-sorting]' - Reverse the current sorting order.
2435 '\\[ibuffer-do-sort-by-alphabetic]' - Sort the buffers lexicographically.
2436 '\\[ibuffer-do-sort-by-recency]' - Sort the buffers by last viewing time.
2437 '\\[ibuffer-do-sort-by-size]' - Sort the buffers by size.
2438 '\\[ibuffer-do-sort-by-major-mode]' - Sort the buffers by major mode.
2439
2440Other commands:
2441
4c38df30
JPW
2442 '\\[ibuffer-update]' - Regenerate the list of all buffers.
2443 Prefix arg means to toggle whether buffers that match
2444 `ibuffer-maybe-show-predicates' should be displayed.
2445
25d2f683
CW
2446 '\\[ibuffer-switch-format]' - Change the current display format.
2447 '\\[forward-line]' - Move point to the next line.
2448 '\\[previous-line]' - Move point to the previous line.
25d2f683
CW
2449 '\\[ibuffer-quit]' - Bury the Ibuffer buffer.
2450 '\\[describe-mode]' - This help.
2451 '\\[ibuffer-diff-with-file]' - View the differences between this buffer
2452 and its associated file.
2453 '\\[ibuffer-visit-buffer]' - View the buffer on this line.
2454 '\\[ibuffer-visit-buffer-other-window]' - As above, but in another window.
2455 '\\[ibuffer-visit-buffer-other-window-noselect]' - As both above, but don't select
2456 the new window.
2457 '\\[ibuffer-bury-buffer]' - Bury (not kill!) the buffer on this line.
2458
cba63a2d 2459** Information on Filtering:
25d2f683
CW
2460
2461 You can filter your ibuffer view via different critera. Each Ibuffer
2462buffer has its own stack of active filters. For example, suppose you
2463are working on an Emacs Lisp project. You can create an Ibuffer
2464buffer displays buffers in just `emacs-lisp' modes via
2465'\\[ibuffer-filter-by-mode] emacs-lisp-mode RET'. In this case, there
2466is just one entry on the filtering stack.
2467
2468You can also combine filters. The various filtering commands push a
2469new filter onto the stack, and the filters combine to show just
2470buffers which satisfy ALL criteria on the stack. For example, suppose
2471you only want to see buffers in `emacs-lisp' mode, whose names begin
2472with \"gnus\". You can accomplish this via:
2473'\\[ibuffer-filter-by-mode] emacs-lisp-mode RET
2474\\[ibuffer-filter-by-name] ^gnus RET'.
2475
2476Additionally, you can OR the top two filters together with
2477'\\[ibuffer-or-filters]'. To see all buffers in either
2478`emacs-lisp-mode' or `lisp-interaction-mode', type:
2479
2480'\\[ibuffer-filter-by-mode] emacs-lisp-mode RET \\[ibuffer-filter-by-mode] lisp-interaction-mode RET \\[ibuffer-or-filters]'.
2481
2482Filters can also be saved and restored using mnemonic names: see the
2483functions `ibuffer-save-filters' and `ibuffer-switch-to-saved-filters'.
2484
2485To remove the top filter on the stack, use '\\[ibuffer-pop-filter]', and
2486to disable all filtering currently in effect, use
cba63a2d
CW
2487'\\[ibuffer-filter-disable]'.
2488
2489** Filter Groups:
2490
2491Once one has mastered filters, the next logical step up is \"filter
2492groups\". A filter group is basically a named group of buffers which
2493match a filter, which are displayed together in an Ibuffer buffer. To
2494create a filter group, simply use the regular functions to create a
2495filter, and then type '\\[ibuffer-filters-to-filter-group]'.
2496
2497A quick example will make things clearer. Suppose that one wants to
2498group all of one's Emacs Lisp buffers together. To do this, type
2499
2500'\\[ibuffer-filter-by-mode] emacs-lisp-mode RET \\[ibuffer-filters-to-filter-group] RET emacs lisp buffers RET'
2501
2502You may, of course, name the group whatever you want; it doesn't have
2503to be \"emacs lisp buffers\". Filter groups may be composed of any
2504arbitrary combination of filters.
2505
2506Just like filters themselves, filter groups act as a stack. Buffers
2507will not be displayed multiple times if they would be included in
2508multiple filter groups; instead, the first filter group is used. The
2509filter groups are displayed in this order of precedence.
2510
2511You may rearrange filter groups by using the regular
2512'\\[ibuffer-kill-line]' and '\\[ibuffer-yank]' pair. Yanked groups
2513will be inserted before the group at point."
25d2f683
CW
2514 (kill-all-local-variables)
2515 (use-local-map ibuffer-mode-map)
2516 (setq major-mode 'ibuffer-mode)
2517 (setq mode-name "Ibuffer")
23eabff6 2518 ;; Include state info next to the mode name.
e47b4224 2519 (set (make-local-variable 'mode-line-process)
23eabff6
SM
2520 '((ibuffer-sorting-mode (:eval (symbol-name ibuffer-sorting-mode))
2521 "view time")
2522 (ibuffer-sorting-reversep " [rev]")
2523 (ibuffer-auto-mode " (Auto)")
2524 ;; Only list the filters if they're not already in the header-line.
2525 (header-line-format
2526 ""
2527 (:eval (if (functionp 'ibuffer-format-qualifier)
2528 (mapconcat 'ibuffer-format-qualifier
2529 ibuffer-filtering-qualifiers ""))))))
2530 (setq header-line-format
2531 (if ibuffer-use-header-line
2532 ;; Display the part that won't be in the mode-line.
2533 (mapcar (lambda (elem) (if (eq (car-safe elem) 'header-line-format)
2534 (nth 2 elem) elem))
2535 mode-line-process)))
2536
25d2f683
CW
2537 (setq buffer-read-only t)
2538 (buffer-disable-undo)
3eda3649 2539 (setq truncate-lines ibuffer-truncate-lines)
25d2f683
CW
2540 ;; This makes things less ugly for Emacs 21 users with a non-nil
2541 ;; `show-trailing-whitespace'.
2542 (setq show-trailing-whitespace nil)
4ba16127
JPW
2543 ;; disable `show-paren-mode' buffer-locally
2544 (if (bound-and-true-p show-paren-mode)
2545 (set (make-local-variable 'show-paren-mode) nil))
25d2f683
CW
2546 (set (make-local-variable 'revert-buffer-function)
2547 #'ibuffer-update)
2548 (set (make-local-variable 'ibuffer-sorting-mode)
2549 ibuffer-default-sorting-mode)
2550 (set (make-local-variable 'ibuffer-sorting-reversep)
2551 ibuffer-default-sorting-reversep)
2552 (set (make-local-variable 'ibuffer-shrink-to-minimum-size)
2553 ibuffer-default-shrink-to-minimum-size)
957237cb
JPW
2554 (set (make-local-variable 'ibuffer-display-maybe-show-predicates)
2555 ibuffer-default-display-maybe-show-predicates)
25d2f683 2556 (set (make-local-variable 'ibuffer-filtering-qualifiers) nil)
cba63a2d
CW
2557 (set (make-local-variable 'ibuffer-filter-groups) nil)
2558 (set (make-local-variable 'ibuffer-filter-group-kill-ring) nil)
2559 (set (make-local-variable 'ibuffer-hidden-filter-groups) nil)
25d2f683
CW
2560 (set (make-local-variable 'ibuffer-compiled-formats) nil)
2561 (set (make-local-variable 'ibuffer-cached-formats) nil)
2562 (set (make-local-variable 'ibuffer-cached-eliding-string) nil)
2563 (set (make-local-variable 'ibuffer-cached-elide-long-columns) nil)
2564 (set (make-local-variable 'ibuffer-current-format) nil)
4ed1f829 2565 (set (make-local-variable 'ibuffer-restore-window-config-on-quit) nil)
25d2f683 2566 (set (make-local-variable 'ibuffer-did-modification) nil)
b5cd37ea
CW
2567 (set (make-local-variable 'ibuffer-tmp-hide-regexps) nil)
2568 (set (make-local-variable 'ibuffer-tmp-show-regexps) nil)
25d2f683
CW
2569 (define-key ibuffer-mode-map [menu-bar edit] 'undefined)
2570 (define-key ibuffer-mode-map [menu-bar operate] (cons "Operate" ibuffer-mode-operate-map))
2571 (ibuffer-update-format)
2572 (when ibuffer-default-directory
2573 (setq default-directory ibuffer-default-directory))
214fee7a 2574 (add-hook 'change-major-mode-hook 'font-lock-defontify nil t)
23eabff6 2575 (run-mode-hooks 'ibuffer-mode-hook))
25d2f683
CW
2576
2577(provide 'ibuffer)
2578
4e4a724c
JPW
2579(run-hooks 'ibuffer-load-hook)
2580
25d2f683
CW
2581;; Local Variables:
2582;; coding: iso-8859-1
2583;; End:
2584
23eabff6 2585;; arch-tag: 72581688-0603-4954-b8cf-837c700f62e8
25d2f683 2586;;; ibuffer.el ends here