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