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